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

返回此组汇总的来源数据列的数量。此索引从 1 开始，如果此组汇总了电子表格“A”列中的来源数据，此方法会返回 1。

返回

Integer - 来源数据列编号

授权

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

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

---

getSourceDataSourceColumn()

返回数据透视组要对其进行运算的数据源列。如果数据透视表不是 {DataSourcePivotTableApi}，则返回 null。

返回

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。

返回

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.
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	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