Class DataSourcePivotTable

DataSourcePivotTable

Access and modify existing data source pivot table. To create a new data source pivot table, use Range.createDataSourcePivotTable(dataSource) .

Only use this class with data that's connected to a database.

Methods

Method	Return type	Brief description
`addColumnGroup(columnName)`	`PivotGroup`	Adds a new pivot column group based on the specified data source column.
`addFilter(columnName, filterCriteria)`	`PivotFilter`	Adds a new filter based on the specified data source column with the specified filter criteria.
`addPivotValue(columnName, summarizeFunction)`	`PivotValue`	Adds a new pivot value based on the specified data source column with the specified summarize function.
`addRowGroup(columnName)`	`PivotGroup`	Adds a new pivot row group based on the specified data source column.
`asPivotTable()`	`PivotTable`	Returns the data source pivot table as a regular pivot table object.
`cancelDataRefresh()`	`DataSourcePivotTable`	Cancels the data refresh associated with this object if it's currently running.
`forceRefreshData()`	`DataSourcePivotTable`	Refreshes the data of this object regardless of the current state.
`getDataSource()`	`DataSource`	Gets the data source the object is linked to.
`getStatus()`	`DataExecutionStatus`	Gets the data execution status of the object.
`refreshData()`	`DataSourcePivotTable`	Refreshes the data of the object.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Waits until the current execution completes, timing out after the provided number of seconds.

Detailed documentation

`addColumnGroup(columnName)`

Adds a new pivot column group based on the specified data source column.

Parameters

Name	Type	Description
`columnName`	`String`	The data souce column name the pivot group is based on.

Return

PivotGroup — The new pivot group.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`addFilter(columnName, filterCriteria)`

Adds a new filter based on the specified data source column with the specified filter criteria.

Parameters

Name	Type	Description
`columnName`	`String`	The data souce column name the filter is based on.
`filterCriteria`	`FilterCriteria`	The criteria the filter uses.

Return

PivotFilter — The new filter.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`addPivotValue(columnName, summarizeFunction)`

Adds a new pivot value based on the specified data source column with the specified summarize function.

Parameters

Name	Type	Description
`columnName`	`String`	The data souce column name the pivot value is based on.
`summarizeFunction`	`PivotTableSummarizeFunction`	The summarize function the pivot value uses.

Return

PivotValue — The new pivot value.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`addRowGroup(columnName)`

Adds a new pivot row group based on the specified data source column.

Parameters

Name	Type	Description
`columnName`	`String`	The data souce column name the pivot group is based on.

Return

PivotGroup — The new pivot group.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`asPivotTable()`

Returns the data source pivot table as a regular pivot table object.

Return

PivotTable — The pivot table.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`cancelDataRefresh()`

Cancels the data refresh associated with this object if it's currently running.

This example shows how to cancel a formula refresh.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for specific data source type.

Return

DataSourcePivotTable — The data object.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`forceRefreshData()`

Refreshes the data of this object regardless of the current state. See refreshData() for more details. If you want to cancel a currently running refresh of this object, see cancelDataRefresh() .

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for specific data source type.

Return

DataSourcePivotTable — The data object.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`getDataSource()`

Gets the data source the object is linked to.

Return

DataSource — The data source.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`getStatus()`

Gets the data execution status of the object.

Return

DataExecutionStatus — The data execution status.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`refreshData()`

Refreshes the data of the object.

Throws an exception if currently in error state. Use DataSource#updateSpec() to update the specification. The method is preferred over forceRefreshData() to prevent unexpected edits on data source.

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for specific data source type.

Return

DataSourcePivotTable — The data object.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`waitForCompletion(timeoutInSeconds)`

Waits until the current execution completes, timing out after the provided number of seconds. Throws an exception if the execution is not completed when timing out, but does not cancel the data execution.

Parameters

Name	Type	Description
`timeoutInSeconds`	`Integer`	The time to wait for data execution, in seconds. The maximum is 300 seconds.

Return

DataExecutionStatus — The data execution status.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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