Class DataSourceTableFilter

AI-generated Key Takeaways

• DataSourceTableFilter allows you to access and modify existing filters applied to data source tables connected to a database.

• You can get information about the filter, such as the column it applies to, the table it belongs to, and its criteria, using methods like getDataSourceColumn(), getDataSourceTable(), and getFilterCriteria().

• Modify or delete a filter by utilizing the setFilterCriteria() and remove() methods respectively.

• All methods within DataSourceTableFilter necessitate authorization with specific scopes related to spreadsheet access.

DataSourceTableFilter

Access and modify an existing data source table filter. To create a new data source table filter, use DataSourceTable.addFilter(columnName, filterCriteria).

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

Methods

Method	Return type	Brief description
getDataSourceColumn()	DataSourceColumn	Returns the data source column this filter applies to.
getDataSourceTable()	DataSourceTable	Returns the DataSourceTable that this filter belongs to.
getFilterCriteria()	FilterCriteria	Returns the filter criteria for this filter.
remove()	void	Removes this filter from the data source object.
setFilterCriteria(filterCriteria)	DataSourceTableFilter	Sets the filter criteria for this filter.

Detailed documentation

getDataSourceColumn()

Returns the data source column this filter applies to.

Return

DataSourceColumn — The data source column.

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

---

getDataSourceTable()

Returns the DataSourceTable that this filter belongs to.

Return

DataSourceTable — 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

FilterCriteria — 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
filterCriteria	FilterCriteria	The filter criteria to set.

Return

DataSourceTableFilter — 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