Class DataSourcePivotTable

DataSourcePivotTable

الوصول إلى الجدول المحوري لمصدر البيانات الحالي وتعديله. لإنشاء جدول محوري جديد لمصدر بيانات، استخدِم Range.createDataSourcePivotTable(dataSource).

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

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
addColumnGroup(columnName)PivotGroupتضيف مجموعة أعمدة محورية جديدة استنادًا إلى عمود مصدر البيانات المحدّد.
addFilter(columnName, filterCriteria)PivotFilterتتم إضافة فلتر جديد استنادًا إلى عمود مصدر البيانات المحدّد ومعايير الفلترة المحدَّدة.
addPivotValue(columnName, summarizeFunction)PivotValueتضيف قيمة محورية جديدة استنادًا إلى عمود مصدر البيانات المحدد مع دالة التلخيص المحددة.
addRowGroup(columnName)PivotGroupتضيف مجموعة صفوف محورية جديدة بناءً على عمود مصدر البيانات المحدد.
asPivotTable()PivotTableتعرض الجدول المحوري لمصدر البيانات ككائن جدول محوري عادي.
cancelDataRefresh()DataSourcePivotTableيؤدي هذا الإجراء إلى إلغاء عملية إعادة تحميل البيانات المرتبطة بهذا العنصر إذا كان قيد التشغيل حاليًا.
forceRefreshData()DataSourcePivotTableإعادة تحميل بيانات هذا العنصر بغض النظر عن الحالة الحالية
getDataSource()DataSourceالحصول على مصدر البيانات المرتبط بالكائن.
getStatus()DataExecutionStatusللحصول على حالة تنفيذ البيانات للكائن.
refreshData()DataSourcePivotTableلإعادة تحميل بيانات العنصر.
waitForCompletion(timeoutInSeconds)DataExecutionStatusانتظر إلى أن تكتمل عملية التنفيذ الحالية، وانتظِر بعد عدد الثواني المحدّد.

الوثائق التفصيلية

addColumnGroup(columnName)

تضيف مجموعة أعمدة محورية جديدة استنادًا إلى عمود مصدر البيانات المحدّد.

المَعلمات

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

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

PivotGroup - المجموعة المحورية الجديدة.

التفويض

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

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

addFilter(columnName, filterCriteria)

تتم إضافة فلتر جديد استنادًا إلى عمود مصدر البيانات المحدّد ومعايير الفلترة المحدَّدة.

المَعلمات

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

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

PivotFilter: الفلتر الجديد

التفويض

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

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

addPivotValue(columnName, summarizeFunction)

تضيف قيمة محورية جديدة استنادًا إلى عمود مصدر البيانات المحدد مع دالة التلخيص المحددة.

المَعلمات

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

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

PivotValue - القيمة المحورية الجديدة

التفويض

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

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

addRowGroup(columnName)

تضيف مجموعة صفوف محورية جديدة بناءً على عمود مصدر البيانات المحدد.

المَعلمات

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

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

PivotGroup - المجموعة المحورية الجديدة.

التفويض

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

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

asPivotTable()

تعرض الجدول المحوري لمصدر البيانات ككائن جدول محوري عادي.

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

PivotTable: الجدول المحوري

التفويض

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

  • 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() لتفعيل تنفيذ البيانات لنوع محدّد من مصدر البيانات.

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

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

التفويض

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

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

forceRefreshData()

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

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

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

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

التفويض

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

  • 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

getStatus()

للحصول على حالة تنفيذ البيانات للكائن.

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

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

التفويض

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

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

refreshData()

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

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

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

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

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

التفويض

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

  • 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