{/* Do not edit this file. It is automatically generated by API Documenter. */}


## FilteringOptions

Setting model related to column filtering

**Signature:**

```typescript
export interface FilteringOptions
```

## Remarks

When setting it as an option in [Grid](/refs/Class/GridBase), you only need to enter the necessary information.

## Example


```js
grid.setFilteringOptions({enabled: false});
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [automating](/refs/Interface/FilteringOptions#automating) | [FilterAutomatingOptions](/refs/Interface/FilterAutomatingOptions) | Setting model for automatic filtering |
| [clearFocusWhenFiltered](/refs/Interface/FilteringOptions#clearfocuswhenfiltered) | boolean | Whether to clear focus if no valid rows are found after filtering |
| [commitBeforeFiltering](/refs/Interface/FilteringOptions#commitbeforefiltering) | boolean | Whether to commit before filtering |
| [enabled](/refs/Interface/FilteringOptions#enabled) | boolean | Whether the filter box can be displayed by clicking the filter handle or indicator head |
| [handleVisibility](/refs/Interface/FilteringOptions#handlevisibility) | [HandleVisibility](/refs/realgrid#handlevisibility) | How to display filter handles |
| [includeParentItem](/refs/Interface/FilteringOptions#includeparentitem) | boolean | Whether to also display parent rows of data rows retrieved from TreeView |
| [selector](/refs/Interface/FilteringOptions#selector) | [FilterSelectorOptions](/refs/Interface/FilterSelectorOptions) | Set model for filter selection box |
| [toast](/refs/Interface/FilteringOptions#toast) | [ToastOptions](/refs/Interface/ToastOptions) | Toast-related settings |

## Properties Desc

### automating

Settings model for automatic filtering

`Type` - [FilterAutomatingOptions](/refs/Interface/FilterAutomatingOptions)

**Remarks:**

It follows the [FilterAutomatingOptions](/refs/Interface/FilterAutomatingOptions) model.

<hr/>

### clearFocusWhenFiltered

Whether to remove focus if there are no valid rows after filtering

`Type` - boolean

<hr/>

### commitBeforeFiltering

Whether to commit before filtering

`Type` - boolean

<hr/>

### enabled

Whether the filter box can be displayed by clicking the filter handle or indicator head.

`Type` - boolean

<hr/>

### handleVisibility

How filter handles are displayed

`Type` - [HandleVisibility](/refs/realgrid#handlevisibility)

<hr/>

### includeParentItem

Whether to also display the parent row of the data row retrieved from the TreeView.

`Type` - boolean

<hr/>

### selector

Settings model for filter selection box

`Type` - [FilterSelectorOptions](/refs/Interface/FilterSelectorOptions)

**Remarks:**

It follows the [FilterSelectorOptions](/refs/Interface/FilterSelectorOptions) model.

<hr/>

### toast

Toast-related settings

`Type` - [ToastOptions](/refs/Interface/ToastOptions)

**Remarks:**

It follows the [ToastOptions](/refs/Interface/ToastOptions) model.

<hr/>