此页面由 Cloud Translation API 翻译。

Class PivotGroup

访问和修改数据透视表分组分组。

方法

方法	返回类型	简介
`addManualGroupingRule(groupName, groupMembers)`	`PivotGroup`	为此数据透视分组添加手动分组规则。
`areLabelsRepeated()`	`Boolean`	返回标签是否显示为重复。
`clearGroupingRule()`	`PivotGroup`	从此数据透视表元素组中移除所有分组规则。
`clearSort()`	`PivotGroup`	移除对此群组应用的任何排序。
`getDateTimeGroupingRule()`	`DateTimeGroupingRule`	返回数据透视分组的日期时间分组规则，如果没有日期时间，则返回 `null` 。
`getDimension()`	`Dimension`	返回该组是行组还是列组。
`getGroupLimit()`	`PivotGroupLimit`	返回数据透视表元素组的数据透视表元素组限制。
`getIndex()`	`Integer`	返回此数据透视分组在当前分组顺序中的索引。
`getPivotTable()`	`PivotTable`	返回此分组所属的 `PivotTable`。
`getSourceDataColumn()`	`Integer`	返回该组汇总的源数据列的数量。
`getSourceDataSourceColumn()`	`DataSourceColumn`	返回对数据透视组执行操作的数据源列。
`hideRepeatedLabels()`	`PivotGroup`	隐藏此分组的重复标签。
`isSortAscending()`	`Boolean`	如果排序是升序，返回 `true`；如果排序顺序是 `false`，则返回 `false` 降序。
`moveToIndex(index)`	`PivotGroup`	将此组移至行组或列组的当前列表中的指定位置。
`remove()`	`void`	从表格中移除此数据透视表元素组。
`removeManualGroupingRule(groupName)`	`PivotGroup`	移除具有指定 `groupName` 的手动分组规则。
`resetDisplayName()`	`PivotGroup`	将此组在数据透视表中的显示名称重置为默认值。
`setDateTimeGroupingRule(dateTimeGroupingRuleType)`	`PivotGroup`	为数据透视表元素设置日期时间分组规则。
`setDisplayName(name)`	`PivotGroup`	设置此组在数据透视表中的显示名称。
`setGroupLimit(countLimit)`	`PivotGroup`	为数据透视分组设置数据透视分组限制。
`setHistogramGroupingRule(minValue, maxValue, intervalSize)`	`PivotGroup`	为此数据透视分组设置直方图分组规则。
`showRepeatedLabels()`	`PivotGroup`	当有多个行或列分组时，此方法会显示此分组的标签为后续分组的每个条目发出。
`showTotals(showTotals)`	`PivotGroup`	设置是否在表格中显示此数据透视表组的总计值。
`sortAscending()`	`PivotGroup`	将排序顺序设置为升序。
`sortBy(value, oppositeGroupValues)`	`PivotGroup`	根据 `oppositeGroupValues` 中的值按指定的 `PivotValue` 对此组进行排序。
`sortDescending()`	`PivotGroup`	将排序顺序设置为降序。
`totalsAreShown()`	`Boolean`	返回当前是否显示此数据透视组的总计值。

详细文档

`addManualGroupingRule(groupName, groupMembers)`

为此数据透视分组添加手动分组规则。

参数

名称	类型	说明
`groupName`	`String`	此分组规则的名称。
`groupMembers`	`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 - 日期时间分组规则。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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 - 数据透视表元素组限制。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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()`

返回对数据透视组执行操作的数据源列。如果数据透视，则返回 null 表不是 {DataSourcePivotTableApi}。

DataSourceColumn - 需要对数据透视表元素组执行操作的数据源列。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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，则返回 false 降序。

Boolean - 如果排序顺序为升序，则为 true。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`moveToIndex(index)`

将此组移至行组或列组的当前列表中的指定位置。这些索引从 0 开始。例如，如果将该组移至第一个位置，则方法应使用 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 的手动分组规则。

参数

名称	类型	说明
`groupName`	`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()。

参数

名称	类型	说明
`dateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	要设置的规则类型。

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 支持此操作。

参数

名称	类型	说明
`countLimit`	`Integer`	要设置的行数或列数限制。必须为正值。

PivotGroup - 用于链接的数据透视组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setHistogramGroupingRule(minValue, maxValue, intervalSize)`

为此数据透视分组设置直方图分组规则。直方图规则会将值源数据列放入恒定大小的桶中。系统会将从 minValue 到 maxValue 的所有值放入大小为 interval 的组中。所有值低于 minValue 和所有大于 maxValue 的值，它们都放在一个分桶中。

参数

名称	类型	说明
`minValue`	`Integer`	要放入存储分区的项的最小值。小于此值的值都组合到单个存储分区中
`maxValue`	`Integer`	要放入存储分区的项的最大值。大于此值的值都组合到单个存储分区中
`intervalSize`	`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)`

设置是否在表格中显示此数据透视表组的总计值。

参数

名称	类型	说明
`showTotals`	`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)`

根据 oppositeGroupValues 中的值按指定的 PivotValue 对此组进行排序。

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

参数

名称	类型	说明
`value`	`PivotValue`	要排序的透视值。
`oppositeGroupValues`	`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