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 منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

مستندات دقیق

add Column Group(columnName)

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

پارامترها

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

بازگشت

Pivot Group - گروه محوری جدید.

مجوز

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

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

add Filter(columnName, filterCriteria)

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

پارامترها

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

بازگشت

Pivot Filter - فیلتر جدید.

مجوز

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

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

add Pivot Value(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 نام ستون منبع داده بر اساس مقدار محوری است.

بازگشت

Pivot Value - مقدار محوری جدید.

مجوز

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

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

add Pivot Value(columnName, summarizeFunction)

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

برای افزودن مقادیر محوری برای معیارهای Looker، از add Pivot Value(columnName) استفاده کنید.

پارامترها

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

بازگشت

Pivot Value - مقدار محوری جدید.

مجوز

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

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

add Row Group(columnName)

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

پارامترها

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

بازگشت

Pivot Group - گروه محوری جدید.

مجوز

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

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

as Pivot Table()

جدول محوری منبع داده را به عنوان یک شیء جدول محوری معمولی برمی‌گرداند.

بازگشت

Pivot Table - جدول محوری.

مجوز

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

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

cancel Data Refresh()

اگر در حال حاضر در حال اجرا باشد، به‌روزرسانی داده مرتبط با این شی را لغو می‌کند.

این مثال نحوه لغو بازخوانی فرمول را نشان می دهد.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای Spreadsheet App#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

بازگشت

Data Source Pivot Table - شی داده.

مجوز

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

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

force Refresh Data()

داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند. برای جزئیات بیشتر به refresh Data() مراجعه کنید. اگر می‌خواهید یک به‌روزرسانی فعلی این شی را لغو کنید، cancel Data Refresh() مراجعه کنید.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای Spreadsheet App#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

بازگشت

Data Source Pivot Table - شی داده.

مجوز

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

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

get Data Source()

منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.

بازگشت

Data Source - منبع داده.

مجوز

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

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

get Status()

وضعیت اجرای داده شی را دریافت می کند.

بازگشت

Data Execution Status - وضعیت اجرای داده ها.

مجوز

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

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

refresh Data()

داده های شی را تازه می کند.

اگر در حال حاضر در حالت error باشد، یک استثنا می‌اندازد. از Data Source#updateSpec() برای به روز رسانی مشخصات استفاده کنید. برای جلوگیری از ویرایش‌های غیرمنتظره در منبع داده، این روش بر force Refresh Data() ترجیح داده می‌شود.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای Spreadsheet App#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

بازگشت

Data Source Pivot Table - شی داده.

مجوز

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

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

wait For Completion(timeoutInSeconds)

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

پارامترها

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

بازگشت

Data Execution Status - وضعیت اجرای داده ها.

مجوز

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

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