Class DataSourceSheet

البياناتالمصدرورقة

الوصول إلى ورقة مصدر البيانات الحالية وتعديلها لإنشاء ورقة مصدر بيانات جديدة، استخدِم Spreadsheet.insertDataSourceSheet(spec).

لا تستخدِم هذه الفئة إلا مع البيانات المرتبطة بقاعدة بيانات.

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
addFilter(columnName, filterCriteria)DataSourceSheetتضيف هذه السمة فلترًا يتم تطبيقه على ورقة مصدر البيانات.
asSheet()Sheetتعرض هذه الدالة ورقة مصدر البيانات كعنصر ورقة عادية.
autoResizeColumn(columnName)DataSourceSheetيتم تغيير حجم عرض العمود المحدّد تلقائيًا.
autoResizeColumns(columnNames)DataSourceSheetتغيير عرض الأعمدة المحددة تلقائيًا
cancelDataRefresh()DataSourceSheetتلغي هذه الطريقة عملية إعادة تحميل البيانات المرتبطة بهذا العنصر إذا كانت قيد التنفيذ حاليًا.
forceRefreshData()DataSourceSheetتعيد هذه الدالة تحميل بيانات هذا العنصر بغض النظر عن الحالة الحالية.
getColumnWidth(columnName)Integer|nullتعرض هذه الدالة عرض العمود المحدّد.
getDataSource()DataSourceتعرض هذه السمة مصدر البيانات المرتبط بالعنصر.
getFilters()DataSourceSheetFilter[]تعرِض هذه الدالة جميع الفلاتر المطبّقة على ورقة مصدر البيانات.
getSheetValues(columnName)Object[]تعرض هذه الدالة جميع قيم ورقة مصدر البيانات لاسم العمود المقدَّم.
getSheetValues(columnName, startRow, numRows)Object[]تعرض هذه الدالة جميع قيم ورقة مصدر البيانات لاسم العمود المقدَّم بدءًا من صف البداية المقدَّم (استنادًا إلى 1) وحتى numRows المقدَّم.
getSortSpecs()SortSpec[]تعرض هذه الدالة جميع مواصفات الفرز في ورقة بيانات مصدر البيانات.
getStatus()DataExecutionStatusتعرض هذه السمة حالة تنفيذ البيانات الخاصة بالكائن.
refreshData()DataSourceSheetتعمل هذه الدالة على إعادة تحميل بيانات العنصر.
removeFilters(columnName)DataSourceSheetيزيل جميع الفلاتر المطبَّقة على عمود ورقة مصدر البيانات.
removeSortSpec(columnName)DataSourceSheetتزيل هذه الدالة مواصفات الفرز من عمود في ورقة مصدر البيانات.
setColumnWidth(columnName, width)DataSourceSheetتضبط هذه السمة عرض العمود المحدّد.
setColumnWidths(columnNames, width)DataSourceSheetتضبط هذه السمة عرض الأعمدة المحدّدة.
setSortSpec(columnName, ascending)DataSourceSheetتضبط هذه السمة مواصفات الفرز على عمود في ورقة مصدر البيانات.
setSortSpec(columnName, sortOrder)DataSourceSheetتضبط هذه السمة مواصفات الفرز على عمود في ورقة مصدر البيانات.
waitForCompletion(timeoutInSeconds)DataExecutionStatusتنتظر هذه السمة إلى أن يكتمل التنفيذ الحالي، وتنتهي مهلتها بعد عدد الثواني المحدّد.

مستندات تفصيلية

addFilter(columnName, filterCriteria)

تضيف هذه السمة فلترًا يتم تطبيقه على ورقة مصدر البيانات.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود الذي سيتم تطبيق هذا الفلتر عليه
filterCriteriaFilterCriteriaمعايير الفلتر التي سيتم تطبيقها.

الإرجاع

DataSourceSheet: ورقة مصدر البيانات، لتسلسل الطرق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

asSheet()

تعرض هذه الدالة ورقة مصدر البيانات كعنصر ورقة عادية.

الإرجاع

Sheet: ورقة البيانات العادية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumn(columnName)

يتم تغيير حجم عرض العمود المحدّد تلقائيًا.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود

الإرجاع

DataSourceSheet: ورقة مصدر البيانات هذه، تُستخدَم في الربط.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumns(columnNames)

تغيير عرض الأعمدة المحددة تلقائيًا

المعلمات

الاسمالنوعالوصف
columnNamesString[]قائمة بأسماء الأعمدة التي سيتم تعديلها.

الإرجاع

DataSourceSheet: ورقة مصدر البيانات هذه، تُستخدَم في الربط.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

cancelDataRefresh()

تلغي هذه الطريقة عملية إعادة تحميل البيانات المرتبطة بهذا العنصر إذا كانت قيد التنفيذ حاليًا.

يوضّح هذا المثال كيفية إلغاء إعادة تحميل صيغة. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

يتم عرض استثناء إذا لم يكن نوع مصدر البيانات مفعَّلاً. استخدِم طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات محدّد.

الإرجاع

DataSourceSheet: كائن البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

تعيد هذه الدالة تحميل بيانات هذا العنصر بغض النظر عن الحالة الحالية. يمكنك الاطّلاع على refreshData() لمزيد من التفاصيل. إذا أردت إلغاء عملية إعادة تحميل حالية لهذا العنصر، اطّلِع على cancelDataRefresh().

يتم عرض استثناء إذا لم يكن نوع مصدر البيانات مفعَّلاً. استخدِم طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات محدّد.

الإرجاع

DataSourceSheet: كائن البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumnWidth(columnName)

تعرض هذه الدالة عرض العمود المحدّد.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود

الإرجاع

Integer|null: عرض العمود، أو null إذا كان العمود يستخدم العرض التلقائي

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

تعرض هذه السمة مصدر البيانات المرتبط بالعنصر.

الإرجاع

DataSource: مصدر البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilters()

تعرِض هذه الدالة جميع الفلاتر المطبّقة على ورقة مصدر البيانات.

الإرجاع

DataSourceSheetFilter[]: مصفوفة تتضمّن جميع الفلاتر المطبّقة على ورقة مصدر البيانات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName)

تعرض هذه الدالة جميع قيم ورقة مصدر البيانات لاسم العمود المقدَّم.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم عمود مصدر البيانات المطلوب استرداد القيم منه.

الإرجاع

Object[]: مصفوفة ذات بُعد واحد من القيم.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName, startRow, numRows)

تعرض هذه الدالة جميع قيم ورقة مصدر البيانات لاسم العمود المقدَّم بدءًا من صف البداية المقدَّم (استنادًا إلى 1) وحتى numRows المقدَّم.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم عمود مصدر البيانات المطلوب استرداد القيم منه.
startRowIntegerموضع الصف الذي يجب بدء جلب القيم منه.
numRowsIntegerعدد الصفوف المطلوب استرجاعها.

الإرجاع

Object[]: مصفوفة ذات بُعد واحد من القيم.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSortSpecs()

تعرض هذه الدالة جميع مواصفات الفرز في ورقة بيانات مصدر البيانات.

الإرجاع

SortSpec[]: قائمة بمواصفات الترتيب

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

تعرض هذه السمة حالة تنفيذ البيانات الخاصة بالكائن.

الإرجاع

DataExecutionStatus: حالة تنفيذ البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

تعمل هذه الدالة على إعادة تحميل بيانات العنصر.

يُنشئ استثناءً إذا كانت الحالة الحالية هي error. استخدِم DataSource#updateSpec() لتعديل المواصفات. يُفضّل استخدام هذه الطريقة بدلاً من forceRefreshData() لمنع إجراء تعديلات غير متوقّعة على مصدر البيانات.

يتم عرض استثناء إذا لم يكن نوع مصدر البيانات مفعَّلاً. استخدِم طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات محدّد.

الإرجاع

DataSourceSheet: كائن البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeFilters(columnName)

يزيل جميع الفلاتر المطبَّقة على عمود ورقة مصدر البيانات.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود الذي ستتم إزالة الفلاتر منه.

الإرجاع

DataSourceSheet: ورقة مصدر البيانات، لتسلسل الطرق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeSortSpec(columnName)

تزيل هذه الدالة مواصفات الفرز من عمود في ورقة مصدر البيانات.

المعلمات

الاسمالنوعالوصف
columnNameStringتمثّل هذه السمة اسم العمود.

الإرجاع

DataSourceSheet: ورقة مصدر البيانات، للسلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnWidth(columnName, width)

تضبط هذه السمة عرض العمود المحدّد.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود
widthIntegerتمثّل هذه السمة العرض الجديد للعمود.

الإرجاع

DataSourceSheet: ورقة مصدر البيانات هذه، تُستخدَم في الربط.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnWidths(columnNames, width)

تضبط هذه السمة عرض الأعمدة المحدّدة.

المعلمات

الاسمالنوعالوصف
columnNamesString[]قائمة بأسماء الأعمدة التي سيتم تعديلها.
widthIntegerتمثّل هذه السمة العرض الجديد للأعمدة.

الإرجاع

DataSourceSheet: ورقة مصدر البيانات هذه، تُستخدَم في الربط.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, ascending)

تضبط هذه السمة مواصفات الفرز على عمود في ورقة مصدر البيانات.

المعلمات

الاسمالنوعالوصف
columnNameStringتمثّل هذه السمة اسم العمود الذي سيتم الترتيب حسبه.
ascendingBooleanإذا كانت القيمة true، رتِّب العمود ترتيبًا تصاعديًا، وإذا كانت القيمة false، رتِّب العمود ترتيبًا تنازليًا.

الإرجاع

DataSourceSheet: ورقة مصدر البيانات، للسلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, sortOrder)

تضبط هذه السمة مواصفات الفرز على عمود في ورقة مصدر البيانات.

المعلمات

الاسمالنوعالوصف
columnNameStringتمثّل هذه السمة اسم العمود الذي سيتم الترتيب حسبه.
sortOrderSortOrderترتيب الفرز

الإرجاع

DataSourceSheet: ورقة مصدر البيانات، للسلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

تنتظر هذه السمة إلى أن يكتمل التنفيذ الحالي، وتنتهي مهلتها بعد عدد الثواني المحدّد. يُنشئ استثناءً إذا لم يكتمل التنفيذ عند انتهاء المهلة، ولكنّه لا يلغي تنفيذ البيانات.

المعلمات

الاسمالنوعالوصف
timeoutInSecondsIntegerالوقت المطلوب للانتظار حتى يتم تنفيذ البيانات، بالثواني. الحد الأقصى هو 300 ثانية.

الإرجاع

DataExecutionStatus: حالة تنفيذ البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets