Class PivotValue
Page Summary
PivotValue allows you to access and modify value groups within pivot tables.
You can retrieve information about a PivotValue such as its display type, formula, associated PivotTable, source data column, and summarization function.
PivotValue provides methods to modify the display name, set the formula, change how the value is shown, and update the summarization function.
You can remove a PivotValue from the pivot table using the
remove()method.
Access and modify value groups in pivot tables.
Methods
| Method | Return type | Brief description |
|---|---|---|
get | Pivot | Returns the display type describing how this pivot value is currently displayed in the table. |
get | String | Returns the formula used to calculate this value. |
get | Pivot | Returns thePivot which this value belongs to. |
get | Integer | Returns the number of the source data column the pivot value summarizes. |
get | Data | Returns the data source column the pivot value summarizes. |
get | Pivot | Returns this group’s summarization function. |
remove() | void | Remove this value from the pivot table. |
set | Pivot | Sets the display name for this value in the pivot table. |
set | Pivot | Sets the formula used to calculate this value. |
show | Pivot | Displays this value in the pivot table as a function of another value. |
summarize | Pivot | Sets the summarization function. |
Detailed documentation
getDisplayType()
Returns the display type describing how this pivot value is currently displayed in the table.
Return
Pivot — the display type for this pivot value
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getFormula()
Returns the formula used to calculate this value. If this value is not a calculated field thismethod returnsnull.
Return
String — the pivot value for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getPivotTable()
Returns thePivot which this value belongs to.
Return
Pivot — the pivot table this value belongs to
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getSourceDataColumn()
Returns the number of the source data column the pivot value summarizes. This index is 1-based,if this group summarizes source data in column "A" of the spreadsheet this method returns1.
Return
Integer — The source data column number.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getSourceDataSourceColumn()
Returns the data source column the pivot value summarizes. Returnsnull if the pivottable is not a {DataSourcePivotTableApi}.
Return
Data — The source data source column the pivot value summarizes.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getSummarizedBy()
Returns this group’s summarization function.
Return
Pivot — the group's summarization function
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
remove()
Remove this value from the pivot table.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
setDisplayName(name)
Sets the display name for this value in the pivot table.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | The display name to set. |
Return
Pivot — the pivot value for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
setFormula(formula)
Sets the formula used to calculate this value. If this value is not a calculated field thismethod results in an error.
Parameters
| Name | Type | Description |
|---|---|---|
formula | String | The formula to use to calculate this value. |
Return
Pivot — the pivot value for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
showAs(displayType)
Displays this value in the pivot table as a function of another value.
Parameters
| Name | Type | Description |
|---|---|---|
display | Pivot | The way to display the values. |
Return
Pivot — the pivot value for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
summarizeBy(summarizeFunction)
Sets the summarization function.
Parameters
| Name | Type | Description |
|---|---|---|
summarize | Pivot | The function to use to summarize data in this value's source data column. |
Return
Pivot — the pivot value for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.