Class DataSourceSheet

جدولمصادرالبيانات

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

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

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
addFilter(columnName, filterCriteria)DataSourceSheetتُضيف فلترًا يتم تطبيقه على ورقة بيانات المصدر.
asSheet()Sheetتعرِض هذه الدالة ورقة مصدر البيانات كعنصر ورقة عادية.
autoResizeColumn(columnName)DataSourceSheetتغيير حجم عرض العمود المحدّد تلقائيًا
autoResizeColumns(columnNames)DataSourceSheetتغيير حجم عرض الأعمدة المحدّدة تلقائيًا
cancelDataRefresh()DataSourceSheetتلغي إعادة تحميل البيانات المرتبطة بهذا العنصر إذا كانت قيد التنفيذ حاليًا.
forceRefreshData()DataSourceSheetتؤدي هذه الطريقة إلى إعادة تحميل بيانات هذا العنصر بصرف النظر عن حالته الحالية.
getColumnWidth(columnName)Integerلعرض عرض العمود المحدّد.
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 إذا كان العمود يستخدم العرض التلقائي

التفويض

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

  • 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