DataSourceTableFilter

Access and modify an existing data source table filter. To create a new data source table filter,
use `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table#addFilter(String,FilterCriteria)`.


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

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table-filter#getDataSourceColumn()` | `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column` | Returns the data source column this filter applies to. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table-filter#getDataSourceTable()` | `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table` | Returns the `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table` that this filter belongs to. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table-filter#getFilterCriteria()` | `https://developers.google.com/apps-script/reference/spreadsheet/filter-criteria` | Returns the filter criteria for this filter. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table-filter#remove()` | `void` | Removes this filter from the data source object. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table-filter#setFilterCriteria(FilterCriteria)` | `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table-filter#` | Sets the filter criteria for this filter. |

## Detailed documentation

### `getDataSourceColumn()`

Returns the data source column this filter applies to.

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/data-source-column` --- The data source column.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `getDataSourceTable()`

Returns the `https://developers.google.com/apps-script/reference/spreadsheet/data-source-table` that this filter belongs to.

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/data-source-table` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `getFilterCriteria()`

Returns the filter criteria for this filter.

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/filter-criteria` --- The filter criteria for this filter.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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` | `https://developers.google.com/apps-script/reference/spreadsheet/filter-criteria` | The filter criteria to set. |

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/data-source-table-filter#` --- The filter for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`