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)

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

پارامترها

نام تایپ کنید توضیحات
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)

یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده بدون هیچ تابع خلاصه اضافه می کند. فقط برای معیارهای 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 در دسترس است.

پارامترها

نام تایپ کنید توضیحات
columnName String نام ستون منبع داده بر اساس مقدار محوری است.

بازگشت

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

مجوز

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

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

addPivotValue(columnName, summarizeFunction)

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

برای افزودن مقادیر محوری برای معیارهای 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