Class PivotGroup

گروه محوری

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

روش‌ها

روش نوع بازگشتی شرح مختصر
add Manual Grouping Rule(groupName, groupMembers) Pivot Group یک قانون گروه‌بندی دستی برای این گروه محوری اضافه می‌کند.
are Labels Repeated() Boolean برمی‌گرداند که آیا برچسب‌ها به صورت تکراری نمایش داده می‌شوند یا خیر.
clear Grouping Rule() Pivot Group هرگونه قانون گروه‌بندی را از این گروه محوری حذف می‌کند.
clear Sort() Pivot Group هرگونه مرتب‌سازی اعمال‌شده روی این گروه را حذف می‌کند.
get Date Time Grouping Rule() Date Time Grouping Rule |null قانون گروه‌بندی تاریخ-زمان را در گروه محوری برمی‌گرداند، یا اگر هیچ قانون گروه‌بندی تاریخ-زمانی تنظیم نشده باشد، null برمی‌گرداند.
get Dimension() Dimension برمی‌گرداند که آیا این یک گروه سطری است یا ستونی.
get Group Limit() Pivot Group Limit |null محدودیت گروه محوری را برای گروه محوری برمی‌گرداند.
get Index() Integer ایندکس این گروه محوری را به ترتیب فعلی گروه برمی‌گرداند.
get Pivot Table() Pivot Table Pivot Table که این گروه‌بندی به آن تعلق دارد را برمی‌گرداند.
get Source Data Column() Integer شماره ستون داده‌های منبع که این گروه خلاصه می‌کند را برمی‌گرداند.
get Source Data Source Column() Data Source Column |null ستون منبع داده‌ای که گروه محوری روی آن عمل می‌کند را برمی‌گرداند.
hide Repeated Labels() Pivot Group برچسب‌های تکراری این گروه‌بندی را پنهان می‌کند.
is Sort Ascending() Boolean اگر مرتب‌سازی صعودی باشد true و اگر نزولی باشد مقدار false را برمی‌گرداند.
move To Index(index) Pivot Group این گروه را به موقعیت مشخص شده در لیست فعلی گروه‌های سطر یا ستون منتقل می‌کند.
remove() void این گروه محوری را از جدول حذف می‌کند.
remove Manual Grouping Rule(groupName) Pivot Group قانون گروه‌بندی دستی را با group Name مشخص‌شده حذف می‌کند.
reset Display Name() Pivot Group نام نمایشی این گروه را در جدول محوری به مقدار پیش‌فرض آن بازنشانی می‌کند.
set Date Time Grouping Rule(dateTimeGroupingRuleType) Pivot Group قانون گروه‌بندی تاریخ-زمان را روی گروه محوری تنظیم می‌کند.
set Display Name(name) Pivot Group نام نمایشی این گروه را در جدول محوری تنظیم می‌کند.
set Group Limit(countLimit) Pivot Group محدودیت گروه محوری را برای گروه محوری تنظیم می‌کند.
set Histogram Grouping Rule(minValue, maxValue, intervalSize) Pivot Group یک قانون گروه‌بندی هیستوگرام برای این گروه محوری تنظیم می‌کند.
show Repeated Labels() Pivot Group وقتی بیش از یک گروه‌بندی سطر یا ستون وجود داشته باشد، این روش برچسب این گروه‌بندی را برای هر ورودی از گروه‌بندی بعدی نمایش می‌دهد.
show Totals(showTotals) Pivot Group تنظیم می‌کند که آیا مجموع مقادیر این گروه محوری در جدول نمایش داده شود یا خیر.
sort Ascending() Pivot Group ترتیب مرتب‌سازی را به صورت صعودی تنظیم می‌کند.
sort By(value, oppositeGroupValues) Pivot Group این گروه را بر اساس Pivot Value مشخص شده برای مقادیر opposite Group Values مرتب می‌کند.
sort Descending() Pivot Group ترتیب مرتب‌سازی را به صورت نزولی تنظیم می‌کند.
totals Are Shown() Boolean برمی‌گرداند که آیا در حال حاضر مجموع مقادیر برای این گروه محوری نشان داده شده است یا خیر.

مستندات دقیق

addManualGroupingRule(groupName, groupMembers)

یک قانون گروه‌بندی دستی برای این گروه محوری اضافه می‌کند.

پارامترها

نام نوع توضیحات
group Name String نام این قانون گروه‌بندی.
group Members Object[] مقادیری که در این قانون گروه‌بندی گنجانده شده‌اند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

areLabelsRepeated()

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

بازگشت

Boolean - اگر برچسب‌ها تکرار شوند، true و در غیر این صورت false را برمی‌گرداند.

مجوز

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

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

clearGroupingRule()

هرگونه قانون گروه‌بندی را از این گروه محوری حذف می‌کند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

clearSort()

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

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

getDateTimeGroupingRule()

قانون گروه‌بندی تاریخ-زمان را در گروه محوری برمی‌گرداند، یا اگر هیچ قانون گروه‌بندی تاریخ-زمانی تنظیم نشده باشد، null برمی‌گرداند.

بازگشت

DateTimeGroupingRule |null — قانون گروه‌بندی تاریخ-زمان.

مجوز

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

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

getDimension()

برمی‌گرداند که آیا این یک گروه سطری است یا ستونی.

بازگشت

Dimension - بُعدی که نوع این گروه را نشان می‌دهد

مجوز

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

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

getGroupLimit()

محدودیت گروه محوری را برای گروه محوری برمی‌گرداند. در صورت عدم تنظیم محدودیت گروه محوری، null را برمی‌گرداند.

بازگشت

محدودیت PivotGroupLimit |null — محدودیت گروه محوری.

مجوز

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

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

getIndex()

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

بازگشت

Integer - اندیس گروه محوری

مجوز

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

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

getPivotTable()

PivotTable ای را که این گروه بندی به آن تعلق دارد، برمی گرداند.

بازگشت

PivotTable — جدول محوری که این گروه به آن تعلق دارد.

مجوز

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

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

getSourceDataColumn()

شماره ستون داده‌های منبع که این گروه خلاصه می‌کند را برمی‌گرداند. این اندیس مبتنی بر ۱ است، اگر این گروه داده‌های منبع را در ستون "A" از صفحه گسترده خلاصه کند، این متد 1 را برمی‌گرداند.

بازگشت

Integer - شماره ستون داده منبع

مجوز

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

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

getSourceDataSourceColumn()

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

بازگشت

DataSourceColumn |null — ستون منبع داده‌ای که گروه محوری روی آن عمل می‌کند.

مجوز

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

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

hideRepeatedLabels()

برچسب‌های تکراری این گروه‌بندی را پنهان می‌کند. اگر برچسب‌ها از قبل پنهان شده باشند، این منجر به عدم عملیات می‌شود. اگر این متد قبل از گروه‌بندی‌های چندگانه سطر یا ستون فراخوانی شود، وقتی یک گروه‌بندی اضافی اضافه می‌شود، برچسب‌های تکراری پنهان می‌شوند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

isSortAscending()

اگر مرتب‌سازی صعودی باشد true و اگر نزولی باشد مقدار false را برمی‌گرداند.

بازگشت

Boolean - اگر ترتیب مرتب‌سازی صعودی باشد، true برمی‌گرداند.

مجوز

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

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

moveToIndex(index)

این گروه را به موقعیت مشخص شده در لیست فعلی گروه‌های سطر یا ستون منتقل می‌کند. این اندیس‌ها مبتنی بر ۰ هستند. برای مثال، اگر این گروه باید به اولین موقعیت منتقل شود، این متد باید با 0 فراخوانی شود.

پارامترها

نام نوع توضیحات
index Integer شاخصی که باید این گروه‌بندی به آن منتقل شود.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

  • 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

removeManualGroupingRule(groupName)

قانون گروه‌بندی دستی را با groupName مشخص‌شده حذف می‌کند.

پارامترها

نام نوع توضیحات
group Name String نام قانون گروه‌بندی که باید حذف شود.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

resetDisplayName()

نام نمایشی این گروه را در جدول محوری به مقدار پیش‌فرض آن بازنشانی می‌کند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

قانون گروه‌بندی تاریخ-زمان را روی گروه محوری تنظیم می‌کند.

برای حذف قانون، از clearGroupingRule() استفاده کنید.

پارامترها

نام نوع توضیحات
date Time Grouping Rule Type Date Time Grouping Rule Type نوع قانون برای تنظیم.

بازگشت

PivotGroup — گروه محوری، برای زنجیره‌سازی.

مجوز

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

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

setDisplayName(name)

نام نمایشی این گروه را در جدول محوری تنظیم می‌کند.

پارامترها

نام نوع توضیحات
name String نام نمایشی که باید تنظیم شود.

بازگشت

PivotGroup - گروه محوری برای زنجیره‌سازی

مجوز

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

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

setGroupLimit(countLimit)

محدودیت گروه محوری را برای گروه محوری تنظیم می‌کند. این عملیات فقط برای DataSourcePivotTable پشتیبانی می‌شود.

پارامترها

نام نوع توضیحات
count Limit Integer محدودیت تعداد ردیف‌ها یا ستون‌هایی که باید تنظیم شوند. باید مثبت باشد.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

یک قانون گروه‌بندی هیستوگرام برای این گروه محوری تنظیم می‌کند. یک قانون هیستوگرام، مقادیر موجود در یک ستون داده منبع را در سطل‌هایی با اندازه ثابت سازماندهی می‌کند. تمام مقادیر از minValue تا maxValue در گروه‌هایی با اندازه interval قرار می‌گیرند. تمام مقادیر پایین‌تر از minValue و همچنین تمام مقادیر بزرگتر از maxValue در یک سطل قرار می‌گیرند.

پارامترها

نام نوع توضیحات
min Value Integer حداقل مقدار برای قرار دادن اقلام در سطل‌ها. مقادیر کمتر از این مقدار در یک سطل واحد ترکیب می‌شوند.
max Value Integer حداکثر مقداری که می‌توان اقلام را در سطل‌ها قرار داد. مقادیر بیشتر از این مقدار در یک سطل واحد ترکیب می‌شوند.
interval Size Integer

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

showRepeatedLabels()

وقتی بیش از یک گروه‌بندی سطر یا ستون وجود داشته باشد، این متد برچسب این گروه‌بندی را برای هر ورودی از گروه‌بندی بعدی نمایش می‌دهد. اگر برچسب‌ها از قبل تکرار شده باشند، این منجر به عدم عملیات می‌شود. اگر این متد قبل از وجود چندین گروه‌بندی سطر یا ستون فراخوانی شود، وقتی یک گروه‌بندی اضافی اضافه می‌شود، برچسب‌های تکراری نمایش داده می‌شوند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

showTotals(showTotals)

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

پارامترها

نام نوع توضیحات
show Totals Boolean اینکه مجموع امتیازات نمایش داده شود یا خیر.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

sortAscending()

ترتیب مرتب‌سازی را به صورت صعودی تنظیم می‌کند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

sortBy(value, oppositeGroupValues)

این گروه را بر اساس PivotValue مشخص شده برای مقادیر از oppositeGroupValues ​​مرتب می‌کند.

// Sorts the item group by the "SUM of Quantity" pivot value for the specified
// salespersons.
const sheet = SpreadsheetApp.getActiveSheet();
const pivotTable = sheet.getPivotTables()[0];
const itemGroup = pivotTable.getRowGroups()[0];
const sumQuantityValue = pivotTable.getPivotValues()[0];
itemGroup.sortBy(sumQuantityValue, ['Beth', 'Amir', 'Devyn']);

پارامترها

نام نوع توضیحات
value Pivot Value مقدار محوری که قرار است بر اساس آن مرتب‌سازی انجام شود.
opposite Group Values Object[] مقادیر یک گروه محوری مخالف (یک گروه ستونی در صورت مرتب‌سازی یک گروه ردیفی، یا یک گروه ردیفی در صورت مرتب‌سازی یک گروه ستونی) که برای مرتب‌سازی استفاده می‌شوند. ترتیب این مقادیر، اولویت شکست تساوی را تعیین می‌کند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

sortDescending()

ترتیب مرتب‌سازی را به صورت نزولی تنظیم می‌کند.

بازگشت

PivotGroup — گروه محوری برای زنجیره‌سازی.

مجوز

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

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

totalsAreShown()

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

بازگشت

Boolean - اگر مجموع مقادیر برای این گروه محوری نمایش داده شود، true برمی‌گرداند؛ در غیر این صورت false را برمی‌گرداند.

مجوز

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

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