Class PivotValue

透视值

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

方法

方法返回类型简介
getDisplayType()PivotValueDisplayType返回显示类型，用于描述相应透视值当前在表格中的显示方式。
getFormula()String返回用于计算此值的公式。
getPivotTable()PivotTable返回相应值所属的 PivotTable。
getSourceDataColumn()Integer返回数据透视值汇总的源数据列的数量。
getSourceDataSourceColumn()DataSourceColumn|null返回数据透视值汇总的数据源列。
getSummarizedBy()PivotTableSummarizeFunction返回相应组的总结函数。
remove()void从透视表中移除此值。
setDisplayName(name)PivotValue设置透视表中相应值的显示名称。
setFormula(formula)PivotValue设置用于计算此值的公式。
showAs(displayType)PivotValue在透视表中将此值显示为另一个值的函数。
summarizeBy(summarizeFunction)PivotValue设置总结函数。

详细文档

getDisplayType()

返回显示类型，用于描述相应透视值当前在表格中的显示方式。

返回

PivotValueDisplayType - 相应透视值的显示类型

授权

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

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

getFormula()

返回用于计算此值的公式。如果此值不是计算字段，则此方法会返回 null。

返回

String - 用于链接的透视值

授权

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

  • 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|null - 数据透视值汇总的源数据源列。

授权

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

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

getSummarizedBy()

返回相应组的总结函数。

返回

PivotTableSummarizeFunction - 群组的汇总函数

授权

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

  • 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

setDisplayName(name)

设置透视表中相应值的显示名称。

参数

名称类型说明
nameString要设置的显示名称。

返回

PivotValue - 用于链接的透视值

授权

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

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

setFormula(formula)

设置用于计算此值的公式。如果此值不是计算字段，则此方法会导致错误。

参数

名称类型说明
formulaString用于计算此值的公式。

返回

PivotValue - 用于链接的透视值

授权

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

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

showAs(displayType)

在透视表中将此值显示为另一个值的函数。

参数

名称类型说明
displayTypePivotValueDisplayType显示值的方式。

返回

PivotValue - 用于链接的透视值

授权

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

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

summarizeBy(summarizeFunction)

设置总结函数。

参数

名称类型说明
summarizeFunctionPivotTableSummarizeFunction用于汇总相应值在源数据列中的数据的函数。

返回

PivotValue - 用于链接的透视值

授权

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

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