Class DataSourcePivotTable

جدول محوری منبع داده

دسترسی و تغییر جدول محوری منبع داده موجود. برای ایجاد یک جدول محوری منبع داده جدید، از Range.createDataSourcePivotTable(dataSource) استفاده کنید.

فقط از این کلاس با داده‌هایی که به پایگاه داده متصل هستند استفاده کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
add Column Group(columnName) Pivot Group یک گروه ستون محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می‌کند.
add Filter(columnName, filterCriteria) Pivot Filter یک فیلتر جدید بر اساس ستون منبع داده مشخص شده با معیارهای فیلتر مشخص شده اضافه می‌کند.
add Pivot Value(columnName) Pivot Value یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده بدون هیچ تابع خلاصه‌سازی اضافه می‌کند.
add Pivot Value(columnName, summarizeFunction) Pivot Value یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده با تابع خلاصه مشخص شده اضافه می‌کند.
add Row Group(columnName) Pivot Group یک گروه ردیف محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می‌کند.
as Pivot Table() Pivot Table جدول محوری منبع داده را به عنوان یک شیء جدول محوری معمولی برمی‌گرداند.
cancel Data Refresh() Data Source Pivot Table اگر در حال حاضر این شیء در حال اجرا باشد، به‌روزرسانی داده‌های مرتبط با آن را لغو می‌کند.
force Refresh Data() Data Source Pivot Table داده‌های این شیء را صرف نظر از وضعیت فعلی آن، به‌روزرسانی می‌کند.
get Data Source() Data Source منبع داده‌ای که شیء به آن لینک شده است را دریافت می‌کند.
get Status() Data Execution Status وضعیت اجرای داده‌ی شیء را دریافت می‌کند.
refresh Data() Data Source Pivot Table داده‌های شیء را به‌روزرسانی می‌کند.
wait For Completion(timeoutInSeconds) Data Execution Status منتظر می‌ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه‌های ارائه شده، زمان‌بندی خاتمه می‌یابد.

مستندات دقیق

addColumnGroup(columnName)

یک گروه ستون محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می‌کند.

پارامترها

نام نوع توضیحات
column Name String نام ستون منبع داده‌ای که گروه محوری بر اساس آن ساخته شده است.

بازگشت

PivotGroup — گروه محوری جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

addFilter(columnName, filterCriteria)

یک فیلتر جدید بر اساس ستون منبع داده مشخص شده با معیارهای فیلتر مشخص شده اضافه می‌کند.

پارامترها

نام نوع توضیحات
column Name String نام ستون منبع داده‌ای که فیلتر بر اساس آن ساخته شده است.
filter Criteria Filter Criteria معیارهایی که فیلتر استفاده می‌کند.

بازگشت

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 در دسترس است.

پارامترها

نام نوع توضیحات
column Name String نام ستون منبع داده که مقدار محوری بر اساس آن ایجاد شده است.

بازگشت

PivotValue - مقدار محوری جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

addPivotValue(columnName, summarizeFunction)

یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده با تابع خلاصه مشخص شده اضافه می‌کند.

برای اضافه کردن مقادیر محوری برای معیارهای Looker، addPivotValue(columnName) استفاده کنید.

پارامترها

نام نوع توضیحات
column Name String نام ستون منبع داده که مقدار محوری بر اساس آن ایجاد شده است.
summarize Function Pivot Table Summarize Function تابع خلاصه‌ای که مقدار محوری از آن استفاده می‌کند.

بازگشت

PivotValue - مقدار محوری جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

addRowGroup(columnName)

یک گروه ردیف محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می‌کند.

پارامترها

نام نوع توضیحات
column Name 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)

منتظر می‌ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه‌های مشخص شده، زمان‌بندی خاتمه می‌یابد. اگر اجرا هنگام اتمام زمان‌بندی کامل نشود، استثنا ایجاد می‌کند، اما اجرای داده‌ها را لغو نمی‌کند.

پارامترها

نام نوع توضیحات
timeout In Seconds Integer زمان انتظار برای اجرای داده، بر حسب ثانیه. حداکثر ۳۰۰ ثانیه است.

بازگشت

DataExecutionStatus — وضعیت اجرای داده‌ها.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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