تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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)`

لإضافة فلتر مطبّق على ورقة بيانات مصدر البيانات

المعلمات

الاسم	النوع	الوصف
`columnName`	`String`	اسم العمود المطلوب تطبيق هذا الفلتر عليه
`filterCriteria`	`FilterCriteria`	معايير الفلتر المطلوب تطبيقها.

الإرجاع

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)`

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

المعلمات

الاسم	النوع	الوصف
`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().

الإرجاع

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() لمنع إجراء تعديلات غير متوقعة في مصدر البيانات.

الإرجاع

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