الوصول إلى ورقة مصدر البيانات الحالية وتعديلها لإنشاء ورقة بيانات جديدة لمصدر بيانات، استخدِم 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)
تضيف فلترًا تم تطبيقه على ورقة مصدر البيانات.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود الذي تريد تطبيق هذا الفلتر عليه. |
filterCriteria | FilterCriteria | معايير الفلتر المطلوب تطبيقها |
استرجاع الكرة
DataSourceSheet
- ورقة مصدر البيانات، لتسلسل الطرق.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asSheet()
autoResizeColumn(columnName)
يؤدّي هذا الخيار إلى تغيير حجم عرض العمود المحدَّد تلقائيًا.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود |
استرجاع الكرة
DataSourceSheet
: ورقة مصدر البيانات هذه، للتسلسل.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(columnNames)
يؤدّي هذا الخيار إلى تغيير حجم عرض الأعمدة المحدّدة تلقائيًا.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnNames | String[] | قائمة أسماء الأعمدة المطلوب تعديلها. |
استرجاع الكرة
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)
تعرض عرض العمود المحدد.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود |
استرجاع الكرة
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)
تعرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدّم.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم عمود مصدر البيانات المطلوب استرجاع القيم المتعلّقة به. |
استرجاع الكرة
Object[]
- مصفوفة قيم أحادية البُعد.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName, startRow, numRows)
تعرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدم من صف البداية المقدم (استنادًا إلى 1) وحتى numRows
المقدمة.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم عمود مصدر البيانات المطلوب استرجاع القيم المتعلّقة به. |
startRow | Integer | موضع الصف الذي سيتم بدء جلب القيم منه. |
numRows | Integer | عدد الصفوف المطلوب استرجاعها |
استرجاع الكرة
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)
يزيل جميع الفلاتر المطبّقة على عمود ورقة مصدر البيانات.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود المطلوب إزالة الفلاتر منه. |
استرجاع الكرة
DataSourceSheet
- ورقة مصدر البيانات، لتسلسل الطرق.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeSortSpec(columnName)
إزالة مواصفات الترتيب في عمود في ورقة مصدر البيانات
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | تمثّل هذه السمة اسم العمود. |
استرجاع الكرة
DataSourceSheet
: ورقة مصدر البيانات للتسلسل.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnName, width)
لضبط عرض العمود المحدّد.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود |
width | Integer | العرض الجديد للعمود. |
استرجاع الكرة
DataSourceSheet
: ورقة مصدر البيانات هذه، للتسلسل.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidths(columnNames, width)
لضبط عرض الأعمدة المحددة.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnNames | String[] | قائمة أسماء الأعمدة المطلوب تعديلها. |
width | Integer | العرض الجديد للأعمدة. |
استرجاع الكرة
DataSourceSheet
: ورقة مصدر البيانات هذه، للتسلسل.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, ascending)
لضبط مواصفات الترتيب في عمود في ورقة بيانات مصدر البيانات.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود المطلوب ترتيبه. |
ascending | Boolean | إذا كانت السمة true ، يجب ترتيب العمود تصاعديًا، وإذا كانت false ، سيتم ترتيب العمود تنازليًا. |
استرجاع الكرة
DataSourceSheet
: ورقة مصدر البيانات للتسلسل.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, sortOrder)
لضبط مواصفات الترتيب في عمود في ورقة بيانات مصدر البيانات.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود المطلوب ترتيبه. |
sortOrder | SortOrder | نظام الترتيب |
استرجاع الكرة
DataSourceSheet
: ورقة مصدر البيانات للتسلسل.
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
انتظر إلى أن تكتمل عملية التنفيذ الحالية، وانتظِر بعد عدد الثواني المحدّد. تعرِض استثناءً إذا لم تكتمل عملية التنفيذ عند انتهاء المهلة، ولكنّها لا تلغي تنفيذ البيانات.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
timeoutInSeconds | Integer | وقت انتظار تنفيذ البيانات، بالثواني. الحدّ الأقصى هو 300 ثانية. |
استرجاع الكرة
DataExecutionStatus
- حالة تنفيذ البيانات
التفويض
إنّ النصوص البرمجية التي تستخدم هذه الطريقة تتطلّب الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets