Class DataSourcePivotTable

DataSourcePivotTable

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

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

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
addColumnGroup(columnName)PivotGroupتضيف هذه الدالة مجموعة أعمدة محورية جديدة استنادًا إلى عمود مصدر البيانات المحدّد.
addFilter(columnName, filterCriteria)PivotFilterتضيف هذه الطريقة فلترًا جديدًا استنادًا إلى عمود مصدر البيانات المحدّد مع معايير الفلتر المحدّدة.
addPivotValue(columnName)PivotValueتضيف هذه الدالة قيمة محورية جديدة استنادًا إلى عمود مصدر البيانات المحدّد بدون أي دالة تلخيص.
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)

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

يوضّح الرمز التالي كيف يمكنك إضافة مقياس Looker كقيمة محورية. 

// TODO(developer): Replace with your spreadsheet ID which has a Looker data
// source.
const spreadsheet = SpreadsheetApp.openById('abcd1234');
const datasource = spreadsheet.getDataSources()[0];
const pivotTable = datasource.createDataSourcePivotTableOnNewSheet();

pivotTable.addPivotValue('columnName');

تتوفّر هذه الطريقة لمصادر بيانات Looker فقط.

المَعلمات

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

الإرجاع

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

التفويض

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

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

addPivotValue(columnName, summarizeFunction)

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

لإضافة قيم محورية لمقاييس Looker، استخدِم addPivotValue(columnName).

المَعلمات

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

الإرجاع

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