Class DataSourcePivotTable

الجدولالمحوري لمصدر البيانات

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

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

الطُرق

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

مستندات تفصيلية

addColumnGroup(columnName)

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

---

addFilter(columnName, filterCriteria)

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

---

addPivotValue(columnName)

تضيف قيمة محورية جديدة استنادًا إلى عمود مصدر البيانات المحدّد بدون أي دالة summarizing. لقياسات 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.

المعلَمات

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

الإرجاع

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

التفويض

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

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

---

addPivotValue(columnName, summarizeFunction)

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

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

المعلَمات

الاسم	النوع	الوصف
columnName	String	اسم عمود مصدر البيانات الذي تستند إليه القيمة المحورية.
summarizeFunction	PivotTableSummarizeFunction	دالة التلخيص التي تستخدمها قيمة المحور

الإرجاع

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

التفويض

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

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

---

addRowGroup(columnName)

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

المعلَمات

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

الإرجاع

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)

تنتظر هذه الدالة حتى اكتمال التنفيذ الحالي، وتنتهي مهلة الانتظار بعد عدد الثواني المقدَّم. يُعرِض استثناءً إذا لم يكتمل التنفيذ عند انتهاء المهلة، ولكنّه لا يلغي تنفيذ البيانات.

المعلَمات

الاسم	النوع	الوصف
timeoutInSeconds	Integer	وقت الانتظار لتشغيل البيانات، بالثواني ويبلغ الحد الأقصى 300 ثانية.

الإرجاع

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

التفويض

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

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