Stay organized with collections Save and categorize content based on your preferences.
PivotFilterAccess and modify pivot table filters.
Detailed documentationgetFilterCriteria()
Returns the filter criteria for this pivot filter.
ReturnFilterCriteria
— The filter criteria for this pivot filter.
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.
PivotTable
— The pivot table this filter belongs to.
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."
ReturnInteger
— The number of the source data column this filter applies to.
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}.
DataSourceColumn
— The data source column the filter operates on.
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.
AuthorizationScripts 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 Name Type DescriptionfilterCriteria
FilterCriteria
The filter criteria to set. Return
PivotFilter
— The pivot filter for chaining.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-12 UTC."],[[["`PivotFilter` objects provide methods to access and modify filters applied to pivot tables in Google Sheets."],["You can retrieve filter criteria, identify the associated pivot table and source data column, and remove the filter using dedicated methods."],["The `setFilterCriteria()` method allows you to define specific filtering conditions for the pivot table data."],["These methods require authorization with specific scopes to interact with Google Sheets data."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4