Class PivotTable

جدول محوری

دسترسی و تغییر جداول محوری

روش‌ها

روش نوع بازگشتی شرح مختصر
add Calculated Pivot Value(name, formula) Pivot Value یک مقدار محوری جدید در جدول محوری ایجاد می‌کند که از formula مشخص شده با name مشخص شده محاسبه شده است.
add Column Group(sourceDataColumn) Pivot Group یک گروه‌بندی ستون محوری جدید در جدول محوری تعریف می‌کند.
add Filter(sourceDataColumn, filterCriteria) Pivot Filter یک فیلتر محوری جدید برای جدول محوری ایجاد می‌کند.
add Pivot Value(sourceDataColumn, summarizeFunction) Pivot Value یک مقدار محوری جدید در جدول محوری با summarize Function مشخص شده تعریف می‌کند.
add Row Group(sourceDataColumn) Pivot Group یک گروه‌بندی ردیف محوری جدید در جدول محوری تعریف می‌کند.
as Data Source Pivot Table() Data Source Pivot Table |null اگر جدول محوری به یک Data Source برمی‌گرداند، و در غیر این صورت null برمی‌گرداند.
get Anchor Cell() Range Range برمی‌گرداند که نشان‌دهنده‌ی سلولی است که این جدول محوری در آن قرار دارد.
get Column Groups() Pivot Group[] یک لیست مرتب از گروه‌های ستون در این جدول محوری را برمی‌گرداند.
get Filters() Pivot Filter[] یک لیست مرتب از فیلترهای موجود در این جدول محوری را برمی‌گرداند.
get Pivot Values() Pivot Value[] یک لیست مرتب از مقادیر محوری در این جدول محوری را برمی‌گرداند.
get Row Groups() Pivot Group[] یک لیست مرتب از گروه‌های ردیف در این جدول محوری را برمی‌گرداند.
get Source Data Range() Range محدوده داده‌های منبعی را که جدول محوری بر اساس آن ساخته شده است، برمی‌گرداند.
get Values Display Orientation() Dimension مشخص می‌کند که آیا مقادیر به صورت سطر یا ستون نمایش داده می‌شوند یا خیر.
remove() void این جدول محوری را حذف می‌کند.
set Values Display Orientation(dimension) Pivot Table طرح‌بندی این جدول محوری را برای نمایش مقادیر به صورت ستون یا ردیف تنظیم می‌کند.

مستندات دقیق

addCalculatedPivotValue(name, formula)

یک مقدار محوری جدید در جدول محوری ایجاد می‌کند که از formula مشخص شده با name مشخص شده محاسبه شده است.

پارامترها

نام نوع توضیحات
name String نام این مقدار محوری محاسبه‌شده.
formula String فرمولی که برای محاسبه این مقدار استفاده می‌شود.

بازگشت

PivotValue — PivotValue تازه ایجاد شده

مجوز

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

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

addColumnGroup(sourceDataColumn)

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

پارامترها

نام نوع توضیحات
source Data Column Integer شماره ستونی که این گروه خلاصه می‌کند. این شاخص نشان دهنده تعداد مطلق ستون در صفحه گسترده است؛ 1 نشان دهنده ستون "A"، 2 نشان دهنده ستون B و غیره.

بازگشت

PivotGroup — PivotGroup تازه تأسیس شده

مجوز

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

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

addFilter(sourceDataColumn, filterCriteria)

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

پارامترها

نام نوع توضیحات
source Data Column Integer شماره ستونی که این گروه خلاصه می‌کند. این شاخص نشان دهنده تعداد مطلق ستون در صفحه گسترده است؛ 1 نشان دهنده ستون "A"، 2 نشان دهنده ستون B و غیره.
filter Criteria Filter Criteria معیارهای فیلتر مورد استفاده برای انجام فیلترینگ.

بازگشت

PivotFilter — PivotFilter تازه ایجاد شده

مجوز

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

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

addPivotValue(sourceDataColumn, summarizeFunction)

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

پارامترها

نام نوع توضیحات
source Data Column Integer شماره ستونی که این گروه خلاصه می‌کند. این شاخص نشان دهنده تعداد مطلق ستون در صفحه گسترده است؛ 1 نشان دهنده ستون "A"، 2 نشان دهنده ستون B و غیره.
summarize Function Pivot Table Summarize Function

بازگشت

PivotValue — PivotValue تازه ایجاد شده

مجوز

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

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

addRowGroup(sourceDataColumn)

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

پارامترها

نام نوع توضیحات
source Data Column Integer شماره ستونی که این گروه خلاصه می‌کند. این شاخص نشان دهنده تعداد مطلق ستون در صفحه گسترده است؛ 1 نشان دهنده ستون "A"، 2 نشان دهنده ستون B و غیره.

بازگشت

PivotGroup — PivotGroup تازه تأسیس شده

مجوز

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

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

asDataSourcePivotTable()

اگر جدول محوری به یک DataSource لینک شده باشد، آن را به عنوان یک جدول محوری منبع داده برمی‌گرداند، و در غیر این صورت null برمی‌گرداند.

بازگشت

DataSourcePivotTable |null — یک جدول محوری منبع داده.

مجوز

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

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

getAnchorCell()

Range برمی‌گرداند که نشان‌دهنده‌ی سلولی است که این جدول محوری در آن قرار دارد.

بازگشت

Range - سلول لنگر این جدول محوری

مجوز

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

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

getColumnGroups()

یک لیست مرتب از گروه‌های ستون در این جدول محوری را برمی‌گرداند.

بازگشت

PivotGroup[] - گروه‌های ستونی در این جدول محوری

مجوز

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

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

getFilters()

یک لیست مرتب از فیلترهای موجود در این جدول محوری را برمی‌گرداند.

بازگشت

PivotFilter[] — فیلترهای موجود در این جدول محوری

مجوز

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

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

getPivotValues()

یک لیست مرتب از مقادیر محوری در این جدول محوری را برمی‌گرداند.

بازگشت

PivotValue[] — مقادیر محوری در این جدول محوری

مجوز

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

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

getRowGroups()

یک لیست مرتب از گروه‌های ردیف در این جدول محوری را برمی‌گرداند.

بازگشت

PivotGroup[] — گروه‌های سطری در این جدول محوری

مجوز

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

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

getSourceDataRange()

محدوده داده‌های منبعی را که جدول محوری بر اساس آن ساخته شده است، برمی‌گرداند.

بازگشت

Range — محدوده داده‌های منبع این جدول محوری.

مجوز

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

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

getValuesDisplayOrientation()

مشخص می‌کند که آیا مقادیر به صورت سطر یا ستون نمایش داده می‌شوند یا خیر.

بازگشت

Dimension - اینکه آیا مقادیر به صورت ردیف یا ستون نمایش داده می‌شوند

مجوز

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

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

remove()

این جدول محوری را حذف می‌کند. عملیات بیشتر روی این جدول محوری منجر به خطا می‌شود.

مجوز

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

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

setValuesDisplayOrientation(dimension)

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

پارامترها

نام نوع توضیحات
dimension Dimension بُعدی که نحوه نمایش مقادیر محوری را نشان می‌دهد.

بازگشت

PivotTable - جدول محوری برای زنجیره‌سازی

مجوز

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

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