Class PivotFilter

  • PivotFilter is used to access and modify pivot table filters.

  • You can get or set the filter criteria for a pivot filter.

  • You can retrieve the pivot table or source data column associated with the filter.

  • A pivot filter can be removed from the pivot table.
PivotFilter

Access and modify pivot table filters.

Methods

MethodReturn typeBrief description
getFilterCriteria()FilterCriteriaReturns the filter criteria for this pivot filter.
getPivotTable()PivotTableReturns the PivotTable that this filter belongs to.
getSourceDataColumn()IntegerReturns the number of the source data column this filter operates on.
getSourceDataSourceColumn()DataSourceColumnReturns the data source column the filter operates on.
remove()voidRemoves this pivot filter from the pivot table.
setFilterCriteria(filterCriteria)PivotFilterSets the filter criteria for this pivot filter.

Detailed documentation

getFilterCriteria()

Returns the filter criteria for this pivot filter.

Return

FilterCriteria — The filter criteria for this pivot 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

getPivotTable()

Returns the PivotTable that this filter belongs to.

Return

PivotTable — The pivot table this filter belongs to.

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

getSourceDataColumn()

Returns the number of the source data column this filter operates on. These indices are 1-based, for example if this filter applies to data in column A of the spreadsheet this method returns "1."

Return

Integer — The number of the source data column this filter applies to.

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

getSourceDataSourceColumn()

Returns the data source column the filter operates on. Returns null if the pivot table is not a {DataSourcePivotTableApi}.

Return

DataSourceColumn — The data source column the filter operates on.

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

remove()

Removes this pivot filter from 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

setFilterCriteria(filterCriteria)

Sets the filter criteria for this pivot filter.

Parameters

NameTypeDescription
filterCriteriaFilterCriteriaThe filter criteria to set.

Return

PivotFilter — The pivot filter for chaining.

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