Class DataSourceTableFilter
-
Access and modify existing data source table filters using the
DataSourceTableFilterclass. -
This class is exclusively for use with data connected to a database.
-
Methods allow you to get the associated data source column and table, retrieve or set the filter criteria, and remove the filter.
Detailed documentation
getDataSourceColumn()
Returns the data source column this filter applies to.
Return
Data — The data source column.
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
getDataSourceTable()
Returns the Data that this filter belongs to.
Return
Data — The data source table, to which this filter belongs.
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
getFilterCriteria()
Returns the filter criteria for this filter.
Return
Filter — The filter criteria for this 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
remove()
Removes this filter from the data source 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
setFilterCriteria(filterCriteria)
Sets the filter criteria for this filter.
Parameters
| Name | Type | Description |
|---|---|---|
filter | Filter | The filter criteria to set. |
Return
Data — The 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