Class DataSourcePivotTable

DataSourcePivotTable

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

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

مواد و روش ها

روش نوع برگشت توضیح مختصر
addColumnGroup(columnName) PivotGroup یک گروه ستون محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می کند.
addFilter(columnName, filterCriteria) PivotFilter یک فیلتر جدید بر اساس ستون منبع داده مشخص شده با معیارهای فیلتر مشخص شده اضافه می کند.
addPivotValue(columnName, summarizeFunction) PivotValue یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده با تابع خلاصه مشخص شده اضافه می کند.
addRowGroup(columnName) PivotGroup یک گروه ردیف محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می کند.
asPivotTable() PivotTable جدول محوری منبع داده را به عنوان یک شیء جدول محوری معمولی برمی‌گرداند.
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, summarizeFunction)

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

مولفه های

نام تایپ کنید شرح
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

forceRefreshData()

داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند. برای جزئیات بیشتر به refreshData() مراجعه کنید.

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