# FilterOptions

Canonical page: https://www.adaptabletools.com/docs/reference/filteroptions

Column Filters (one column) and the Grid Filter (a query across columns).

The filters a user creates are stored on the Layout. These options change how filtering works for the whole grid.

```ts title="TypeScript"
export interface FilterOptions<TData = any> 
```

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [clearFiltersOnStartUp](https://www.adaptabletools.com/docs/reference/filteroptions.md#clearfiltersonstartup) | `boolean` | Clear Grid and Column Filters when AdapTable loads | false |
| [columnFilterOptions](https://www.adaptabletools.com/docs/reference/filteroptions.md#columnfilteroptions) | [`ColumnFilterOptions`](https://www.adaptabletools.com/docs/reference/columnfilteroptions.md) | The filter row under the column headers, and the operator offered first for each data type. |   |
| [customInFilterValues](https://www.adaptabletools.com/docs/reference/filteroptions.md#custominfiltervalues) | `(context: `[`CustomInFilterValuesContext`](https://www.adaptabletools.com/docs/reference/custominfiltervaluescontext.md)`<TData>) => Promise<`[`InFilterValueResult`](https://www.adaptabletools.com/docs/reference/infiltervalueresult.md)`> \| `[`InFilterValueResult`](https://www.adaptabletools.com/docs/reference/infiltervalueresult.md) | Provide custom values (or sorting / count info) when using the `IN` operator in Column or Grid Filter |   |
| [enableFilterOnSpecialColumns](https://www.adaptabletools.com/docs/reference/filteroptions.md#enablefilteronspecialcolumns) | `boolean` | Allow filtering on Calculated &amp; FreeText columns | true |
| [isRowFilterable](https://www.adaptabletools.com/docs/reference/filteroptions.md#isrowfilterable) | `(context: `[`IsRowFilterableContext`](https://www.adaptabletools.com/docs/reference/isrowfilterablecontext.md)`) => boolean` | Configures whether Rows will be evaluated when filtering |   |
| [showDatePicker](https://www.adaptabletools.com/docs/reference/filteroptions.md#showdatepicker) | `boolean` | Show Date Picker (or Date Input) in Filter controls | true |
| [useAdaptableFiltering](https://www.adaptabletools.com/docs/reference/filteroptions.md#useadaptablefiltering) | `boolean` | Use Adaptable&#39;s Column &amp; Grid Filters in preference to AG Grid&#39;s filtering | true |

## Property Details

### clearFiltersOnStartUp

Clear Grid and Column Filters when AdapTable loads

```ts title="TypeScript"
clearFiltersOnStartUp?: boolean;
```

###### Default Value

false

###### Property Value

`boolean`

### columnFilterOptions

The filter row under the column headers, and the operator offered first for each data type.

```ts title="TypeScript"
columnFilterOptions?: ColumnFilterOptions;
```

###### Property Value

[`ColumnFilterOptions`](https://www.adaptabletools.com/docs/reference/columnfilteroptions.md)

### customInFilterValues

Provide custom values (or sorting / count info) when using the `IN` operator in Column or Grid Filter

```ts title="TypeScript"
customInFilterValues?: (context: CustomInFilterValuesContext<TData>) => Promise<InFilterValueResult> | InFilterValueResult;
```

###### Property Value

`(context: `[`CustomInFilterValuesContext`](https://www.adaptabletools.com/docs/reference/custominfiltervaluescontext.md)`<TData>) => Promise<`[`InFilterValueResult`](https://www.adaptabletools.com/docs/reference/infiltervalueresult.md)`> | `[`InFilterValueResult`](https://www.adaptabletools.com/docs/reference/infiltervalueresult.md)

### enableFilterOnSpecialColumns

Allow filtering on Calculated &amp; FreeText columns

```ts title="TypeScript"
enableFilterOnSpecialColumns?: boolean;
```

###### Default Value

true

###### Property Value

`boolean`

### isRowFilterable

Configures whether Rows will be evaluated when filtering

```ts title="TypeScript"
isRowFilterable?: (context: IsRowFilterableContext) => boolean;
```

###### Property Value

`(context: `[`IsRowFilterableContext`](https://www.adaptabletools.com/docs/reference/isrowfilterablecontext.md)`) => boolean`

### showDatePicker

Show Date Picker (or Date Input) in Filter controls

```ts title="TypeScript"
showDatePicker?: boolean;
```

###### Default Value

true

###### Property Value

`boolean`

### useAdaptableFiltering

Use Adaptable&#39;s Column &amp; Grid Filters in preference to AG Grid&#39;s filtering

```ts title="TypeScript"
useAdaptableFiltering?: boolean;
```

###### Default Value

true

###### Property Value

`boolean`
