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


## FilterSelectorOptions

Settings for the selection box of the column filter Model

**Signature:**

```typescript
export interface FilterSelectorOptions 
```

## Remarks

[grid](/refs /Class/GridBase ), just enter the necessary information when setting it as an option.

## Example


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

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [acceptText](/refs/Interface/FilterSelectorOptions#accepttext) | string | Text on the OK button in the filter selection box |
| [activeWhenEnter](/refs/Interface/FilterSelectorOptions#activewhenenter) | boolean | Whether to activate the searched filter after filter search |
| [allCheckText](/refs/Interface/FilterSelectorOptions#allchecktext) | string | Text in the Select All tab |
| [cancelText](/refs/Interface/FilterSelectorOptions#canceltext) | string | Wording on the Cancel button in the filter selection box |
| [closeWhenClick](/refs/Interface/FilterSelectorOptions#closewhenclick) | boolean | Whether the window is closed when the filter is activated |
| [emptyFilterText](/refs/Interface/FilterSelectorOptions#emptyfiltertext) | string | When creating an automatic filter, no value is found. Phrases in the filter tab |
| [expandCategory](/refs/Interface/FilterSelectorOptions#expandcategory) | boolean | Whether to expand category |
| [filterReset](/refs/Interface/FilterSelectorOptions#filterreset) | boolean | Whether or not there is a button to reset all filters |
| [filterResetText](/refs/Interface/FilterSelectorOptions#filterresettext) | string | Column filter selection initialization text |
| [filtersResetText](/refs/Interface/FilterSelectorOptions#filtersresettext) | string | Filter Reset All Text |
| [maxWidth](/refs/Interface/FilterSelectorOptions#maxwidth) | number | Maximum width of filter selection window |
| [minWidth](/refs/Interface/FilterSelectorOptions#minwidth) | number | Minimum width of the filter selection window. If width is 0, it is not applied. |
| [partialSearch](/refs/Interface/FilterSelectorOptions#partialsearch) | boolean | Filter search box visibility |
| [preserveSelection](/refs/Interface/FilterSelectorOptions#preserveselection) | boolean | Preserves the previous selection when searching. |
| [searchedCheckText](/refs/Interface/FilterSelectorOptions#searchedchecktext) | string | Phrases shown instead of selecting all after search |
| [searchIgnoreCase](/refs/Interface/FilterSelectorOptions#searchignorecase) | boolean | Case sensitivity when searching filters |
| [searchPlaceholder](/refs/Interface/FilterSelectorOptions#searchplaceholder) | string | placeholder for search box |
| [showButtons](/refs/Interface/FilterSelectorOptions#showbuttons) | boolean | Whether to display the footer button of the selection box of the column filter |
| [showTitle](/refs/Interface/FilterSelectorOptions#showtitle) | boolean | filter Whether to display the title area at the top |
| [style](/refs/Interface/FilterSelectorOptions#style) | string | class in filter window |
| [textToTitle](/refs/Interface/FilterSelectorOptions#texttotitle) | boolean | Whether to add filter text as `title`{/* */} |
| [title](/refs/Interface/FilterSelectorOptions#title) | string | String displayed at the top of the filter selection window |
| [useFilterResetImage](/refs/Interface/FilterSelectorOptions#usefilterresetimage) | boolean | If set to `true`{/* */}, an image will be displayed instead of filterResetText. |
| [width](/refs/Interface/FilterSelectorOptions#width) | number | filter width |

## Properties Desc

### acceptText

Text on the OK button in the filter selection box

`Type` - string

<hr/>

### activeWhenEnter

Whether to activate the searched filter after filter search

`Type` - boolean

**Remarks:**

When you enter `enter`{/* */} after a filter search, the searched filter is activated.

<hr/>

### allCheckText

Text in the Select All tab

`Type` - string

<hr/>

### cancelText

Text on the Cancel button in the filter selection box

`Type` - string

<hr/>

### closeWhenClick

Whether the window is closed when the filter is activated

`Type` - boolean

**Remarks:**

If [showButtons](/refs/Interface/FilterSelectorOptions#showbuttons) is `false`, the window closes when a filter is selected. If the OK/Cancel button is created by setting [showButtons](/refs/Interface/FilterSelectorOptions#showbuttons) to `true`{/* */}, the window closes when the OK/Cancel button is operated.

<hr/>

### emptyFilterText

No value when creating an automatic filter Text on the Filter tab

`Type` - string

<hr/>

### expandCategory

Whether to expand category

`Type` - boolean

**Remarks:**

When the filter selection box is displayed, the category is displayed in an expanded state.

<hr/>

### filterReset

Is there a button to reset all filters?

`Type` - boolean

<hr/>

### filterResetText

Column filter selection initialization text

`Type` - string

<hr/>

### filtersResetText

Filter full reset text

`Type` - string

<hr/>

### maxWidth

Maximum width of filter selection window

`Type` - number

**Remarks:**

Specifies the maximum width of the filter selection window. In case of `0`{/* */}, it is not applied.

<hr/>

### minWidth

Minimum width of the filter selection window. If width is 0, it is not applied.

`Type` - number

<hr/>

### partialSearch

Filter search box visibility

`Type` - boolean

<hr/>

### preserveSelection

Preserves the previous selection during search.

`Type` - boolean

<hr/>

### searchedCheckText

Phrases displayed instead of selecting all after searching

`Type` - string

<hr/>

### searchIgnoreCase

Case sensitivity when searching filters

`Type` - boolean

**Remarks:**

If `true`{/* */}, the search is case-insensitive.

<hr/>

### searchPlaceholder

placeholder in search box

`Type` - string

<hr/>

### showButtons

Whether to display the footer button of the selection box of the column filter

`Type` - boolean

<hr/>

### showTitle

Filter Whether to display the title area at the top

`Type` - boolean

<hr/>

### style

Filter window class

`Type` - string

<hr/>

### textToTitle

Whether to add filter text as `title`{/* */}

`Type` - boolean

**Remarks:**

Add the filter's text as the element's title so that a tooltip appears when you mouse over it.

<hr/>

### title

String displayed at the top of the filter selection window

`Type` - string

**Remarks:**

If not specified, the text of the column is displayed.

<hr/>

### useFilterResetImage

If set to `true`{/* */}, an image will be displayed instead of filterResetText.

`Type` - boolean

<hr/>

### width

filter width

`Type` - number

**Remarks:**

If it is 0, the width specified in the style file is applied. If it is -1, the width of the filter text is calculated and applied. If it is -2, the width of the column is applied. If it is 0 or more, the specified width is applied.

<hr/>