此页面由 Cloud Translation API 翻译。

Class PivotTable

访问和修改数据透视表。

方法

方法	返回类型	简介
`addCalculatedPivotValue(name, formula)`	`PivotValue`	在数据透视表中创建一个新的透视值，该值是使用指定的 `name` 从指定的 `formula` 计算得出的。
`addColumnGroup(sourceDataColumn)`	`PivotGroup`	在数据透视表中定义新的透视列分组。
`addFilter(sourceDataColumn, filterCriteria)`	`PivotFilter`	为数据透视表创建新的数据透视过滤器。
`addPivotValue(sourceDataColumn, summarizeFunction)`	`PivotValue`	使用指定的 `summarizeFunction` 在数据透视表中定义新的透视值。
`addRowGroup(sourceDataColumn)`	`PivotGroup`	在数据透视表中定义新的透视表行分组。
`asDataSourcePivotTable()`	`DataSourcePivotTable`	如果数据透视表已关联到 `DataSource`，则将其作为数据源数据透视表返回；否则，返回 `null`。
`getAnchorCell()`	`Range`	返回表示此数据透视表锚定的单元格的 `Range`。
`getColumnGroups()`	`PivotGroup[]`	返回此数据透视表中列组的有序列表。
`getFilters()`	`PivotFilter[]`	返回此数据透视表中过滤条件的有序列表。
`getPivotValues()`	`PivotValue[]`	返回此数据透视表中数据透视值的有序列表。
`getRowGroups()`	`PivotGroup[]`	返回此数据透视表中行组的有序列表。
`getSourceDataRange()`	`Range`	返回用于构建数据透视表的源数据范围。
`getValuesDisplayOrientation()`	`Dimension`	返回值是显示为行还是列。
`remove()`	`void`	删除此数据透视表。
`setValuesDisplayOrientation(dimension)`	`PivotTable`	设置此数据透视表的布局，以将值显示为列或行。

详细文档

`addCalculatedPivotValue(name, formula)`

在数据透视表中创建一个新的透视值，该值是使用指定的 name 从指定的 formula 计算得出的。

参数

名称	类型	说明
`name`	`String`	此计算汇总值的名称。
`formula`	`String`	用于计算此值的公式。

PivotValue - 新创建的 PivotValue

授权

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

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

`addColumnGroup(sourceDataColumn)`

在数据透视表中定义新的透视列分组。指定的 sourceDataColumn 表示此分组所依据的源数据中的列。

参数

名称	类型	说明
`sourceDataColumn`	`Integer`	此组汇总的列的编号。此编号表示电子表格中列的绝对编号；`1` 表示列“A”，`2` 表示列 B，依此类推。

PivotGroup - 新创建的 PivotGroup

授权

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

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

`addFilter(sourceDataColumn, filterCriteria)`

为数据透视表创建新的数据透视过滤器。指定的 sourceDataColumn 表示此过滤器要对源数据中的哪个列进行操作。

参数

名称	类型	说明
`sourceDataColumn`	`Integer`	此组汇总的列的编号。此编号表示电子表格中列的绝对编号；`1` 表示列“A”，`2` 表示列 B，依此类推。
`filterCriteria`	`FilterCriteria`	用于执行过滤的过滤条件。

PivotFilter - 新创建的 PivotFilter

授权

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

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

`addPivotValue(sourceDataColumn, summarizeFunction)`

使用指定的 summarizeFunction 在数据透视表中定义新的透视值。指定的 sourceDataColumn 表示此值基于的来源数据中的列。

参数

名称	类型	说明
`sourceDataColumn`	`Integer`	此组汇总的列的编号。此编号表示电子表格中列的绝对编号；`1` 表示列“A”，`2` 表示列 B，依此类推。
`summarizeFunction`	`PivotTableSummarizeFunction`

PivotValue - 新创建的 PivotValue

授权

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

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

`addRowGroup(sourceDataColumn)`

在数据透视表中定义新的透视表行分组。指定的 sourceDataColumn 表示此分组所依据的源数据中的列。

参数

名称	类型	说明
`sourceDataColumn`	`Integer`	此组汇总的列的编号。此编号表示电子表格中列的绝对编号；`1` 表示列“A”，`2` 表示列 B，依此类推。

PivotGroup - 新创建的 PivotGroup

授权

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

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

`asDataSourcePivotTable()`

如果数据透视表已关联到 DataSource，则将其作为数据源数据透视表返回；否则，返回 null。

DataSourcePivotTable - 数据源数据透视表。

授权

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

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