Class DataSourceTableFilter
Stay organized with collections
Save and categorize content based on your preferences.
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
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 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eDataSourceTableFilter\u003c/code\u003e allows you to access and modify existing filters applied to data source tables connected to a database.\u003c/p\u003e\n"],["\u003cp\u003eYou can get information about the filter, such as the column it applies to, the table it belongs to, and its criteria, using methods like \u003ccode\u003egetDataSourceColumn()\u003c/code\u003e, \u003ccode\u003egetDataSourceTable()\u003c/code\u003e, and \u003ccode\u003egetFilterCriteria()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eModify or delete a filter by utilizing the \u003ccode\u003esetFilterCriteria()\u003c/code\u003e and \u003ccode\u003eremove()\u003c/code\u003e methods respectively.\u003c/p\u003e\n"],["\u003cp\u003eAll methods within \u003ccode\u003eDataSourceTableFilter\u003c/code\u003e necessitate authorization with specific scopes related to spreadsheet access.\u003c/p\u003e\n"]]],[],null,["# Class DataSourceTableFilter\n\nDataSourceTableFilter\n\nAccess and modify an existing data source table filter. To create a new data source table filter,\nuse [DataSourceTable.addFilter(columnName, filterCriteria)](/apps-script/reference/spreadsheet/data-source-table#addFilter(String,FilterCriteria)).\n\n\n**Only use this class with data that's connected to a database.** \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [getDataSourceColumn()](#getDataSourceColumn()) | [DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) | Returns the data source column this filter applies to. |\n| [getDataSourceTable()](#getDataSourceTable()) | [DataSourceTable](/apps-script/reference/spreadsheet/data-source-table) | Returns the [DataSourceTable](/apps-script/reference/spreadsheet/data-source-table) that this filter belongs to. |\n| [getFilterCriteria()](#getFilterCriteria()) | [FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) | Returns the filter criteria for this filter. |\n| [remove()](#remove()) | `void` | Removes this filter from the data source object. |\n| [setFilterCriteria(filterCriteria)](#setFilterCriteria(FilterCriteria)) | [DataSourceTableFilter](#) | Sets the filter criteria for this filter. |\n\nDetailed documentation\n----------------------\n\n### `get``Data``Source``Column()`\n\nReturns the data source column this filter applies to.\n\n#### Return\n\n\n[DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) --- The data source column.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Data``Source``Table()`\n\nReturns the [DataSourceTable](/apps-script/reference/spreadsheet/data-source-table) that this filter belongs to.\n\n#### Return\n\n\n[DataSourceTable](/apps-script/reference/spreadsheet/data-source-table) --- The data source table, to which this filter belongs.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Filter``Criteria()`\n\nReturns the filter criteria for this filter.\n\n#### Return\n\n\n[FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) --- The filter criteria for this filter.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `remove()`\n\nRemoves this filter from the data source object.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Filter``Criteria(filterCriteria)`\n\nSets the filter criteria for this filter.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------------|----------------------------------------------------------------------|-----------------------------|\n| `filter``Criteria` | [FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) | The filter criteria to set. |\n\n#### Return\n\n\n[DataSourceTableFilter](#) --- The filter for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`"]]
