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.
var spreadsheet = SpreadsheetApp.openById("abcd1234")
var datasource = spreadsheet.getDataSources()[0];
var 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دالة التلخيص التي تستخدمها القيمة المحورية.

الإرجاع

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