Class PivotTable

透视表

访问和修改数据透视表。

方法

方法返回类型简介
addCalculatedPivotValue(name, formula)PivotValue根据指定的 formula 和 name，在数据透视表中创建一个新的数据透视值。
addColumnGroup(sourceDataColumn)PivotGroup在数据透视表中定义新的透视列分组。
addFilter(sourceDataColumn, filterCriteria)PivotFilter为数据透视表创建新的数据透视过滤条件。
addPivotValue(sourceDataColumn, summarizeFunction)PivotValue在数据透视表中定义具有指定 summarizeFunction 的新透视值。
addRowGroup(sourceDataColumn)PivotGroup在数据透视表中定义新的数据透视行分组。
asDataSourcePivotTable()DataSourcePivotTable|null如果数据透视表已关联到 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)

根据指定的 formula 和 name，在数据透视表中创建一个新的数据透视值。

参数

名称类型说明
nameString相应计算出的透视值的名称。
formulaString用于计算此值的公式。

返回

PivotValue - 新创建的 PivotValue

授权

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

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

addColumnGroup(sourceDataColumn)

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

参数

名称类型说明
sourceDataColumnInteger相应组所汇总的列的编号。此索引表示电子表格中列的绝对编号；1 表示列“A”，2 表示列 B，依此类推。

返回

PivotGroup - 新创建的 PivotGroup

授权

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

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

addFilter(sourceDataColumn, filterCriteria)

为数据透视表创建新的数据透视过滤条件。指定的 sourceDataColumn 表示此过滤条件所作用的源数据中的列。

参数

名称类型说明
sourceDataColumnInteger相应组所汇总的列的编号。此索引表示电子表格中列的绝对编号；1 表示列“A”，2 表示列 B，依此类推。
filterCriteriaFilterCriteria用于执行过滤的过滤条件。

返回

PivotFilter - 新创建的 PivotFilter

授权

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

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

addPivotValue(sourceDataColumn, summarizeFunction)

在数据透视表中定义具有指定 summarizeFunction 的新透视值。指定的 sourceDataColumn 表示此值所依据的源数据中的列。

参数

名称类型说明
sourceDataColumnInteger相应组所汇总的列的编号。此索引表示电子表格中列的绝对编号；1 表示列“A”，2 表示列 B，依此类推。
summarizeFunctionPivotTableSummarizeFunction

返回

PivotValue - 新创建的 PivotValue

授权

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

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

addRowGroup(sourceDataColumn)

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

参数

名称类型说明
sourceDataColumnInteger相应组所汇总的列的编号。此索引表示电子表格中列的绝对编号；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)

设置相应数据透视表的布局，以将值显示为列或行。

参数

名称类型说明
dimensionDimension用于指明如何显示透视值的维度。

返回

PivotTable - 用于链接的数据透视表

授权

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

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