Class DataSourceSheet

DataSourceSheet

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

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

الطُرق

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

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

المَعلمات

الاسمTypeالوصف
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)

تعمل هذه السياسة على تغيير حجم عرض العمود المحدّد تلقائيًا.

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

autoResizeColumns(columnNames)

تعمل هذه السياسة على تغيير حجم عرض الأعمدة المحددة تلقائيًا.

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

forceRefreshData()

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

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

استرجاع الكرة

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

التفويض

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

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

getColumnWidth(columnName)

تعرض عرض العمود المحدد.

المَعلمات

الاسمTypeالوصف
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)

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

المَعلمات

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

استرجاع الكرة

Object[] - مصفوفة قِيَم أحادية البُعد.

التفويض

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

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

getSheetValues(columnName, startRow, numRows)

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

المَعلمات

الاسمTypeالوصف
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)

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

المَعلمات

الاسمTypeالوصف
columnNameStringاسم العمود المطلوب إزالة الفلاتر منه.

استرجاع الكرة

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

التفويض

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

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

removeSortSpec(columnName)

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

setColumnWidth(columnName, width)

لضبط عرض العمود المحدد.

المَعلمات

الاسمTypeالوصف
columnNameStringاسم العمود
widthIntegerالعرض الجديد للعمود.

استرجاع الكرة

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

التفويض

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

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

setColumnWidths(columnNames, width)

لضبط عرض الأعمدة المحددة.

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

setSortSpec(columnName, ascending)

تحدِّد مواصفات الترتيب على عمود في ورقة مصدر البيانات.

المَعلمات

الاسمTypeالوصف
columnNameStringاسم العمود المطلوب ترتيبه
ascendingBooleanفي حال استخدام true، سيتم ترتيب العمود تصاعديًا، وإذا تم اختيار false، سيتم ترتيب العمود تنازليًا.

استرجاع الكرة

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

التفويض

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

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

setSortSpec(columnName, sortOrder)

تحدِّد مواصفات الترتيب على عمود في ورقة مصدر البيانات.

المَعلمات

الاسمTypeالوصف
columnNameStringاسم العمود المطلوب ترتيبه
sortOrderSortOrderنظام الفرز.

استرجاع الكرة

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

التفويض

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

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

waitForCompletion(timeoutInSeconds)

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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