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


## FilterAutomatingOptions

Setting information regarding automatic filtering

**Signature:**

```typescript
export interface FilterAutomatingOptions
```

## Remarks

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

## Example


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

## Events

| Property | Type | Description |
| --- | --- | --- |
| [dateCategoryCallback](/refs/Interface/FilterAutomatingOptions#datecategorycallback) | [CategoryCallback](/refs/realgrid#categorycallback) | Callback to sort dates |
| [numberCategoryCallback](/refs/Interface/FilterAutomatingOptions#numbercategorycallback) | [CategoryCallback](/refs/realgrid#categorycallback) | Callback to classify numbers |
| [textCategoryCallback](/refs/Interface/FilterAutomatingOptions#textcategorycallback) | [CategoryCallback](/refs/realgrid#categorycallback) | Callback to sort string |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [dateCategorize](/refs/Interface/FilterAutomatingOptions#datecategorize) | boolean | Whether to sort dates |
| [dateDayFormat](/refs/Interface/FilterAutomatingOptions#datedayformat) | string | Format of days displayed in entries |
| [dateMonthFormat](/refs/Interface/FilterAutomatingOptions#datemonthformat) | string | Month format displayed in entries |
| [dateQuarterFormat](/refs/Interface/FilterAutomatingOptions#datequarterformat) | string | Branch format displayed in items |
| [dateYearFormat](/refs/Interface/FilterAutomatingOptions#dateyearformat) | string | Year format displayed in entries |
| [filteredDataOnly](/refs/Interface/FilterAutomatingOptions#filtereddataonly) | boolean | Data displayed in FilterSelector |
| [hourFormat](/refs/Interface/FilterAutomatingOptions#hourformat) | string | Time format displayed in items |
| [lookupDisplay](/refs/Interface/FilterAutomatingOptions#lookupdisplay) | boolean | If Column's lookupDisplay is true, the label is displayed instead of the value. |
| [minuteFormat](/refs/Interface/FilterAutomatingOptions#minuteformat) | string | Format of minutes displayed in entries |
| [numberCategorize](/refs/Interface/FilterAutomatingOptions#numbercategorize) | boolean | Whether to classify numbers |
| [secondFormat](/refs/Interface/FilterAutomatingOptions#secondformat) | string | Format of seconds displayed in entries |
| [selectCallback](/refs/Interface/FilterAutomatingOptions#selectcallback) | [FilterCallback](/refs/realgrid#filtercallback) | Callback called when the filter created by [DataColumn.autoFilter](/refs/Interface/DataColumn#autofilter){/* */} is selected |
| [selectorDataOrder](/refs/Interface/FilterAutomatingOptions#selectordataorder) | [FilterSelectorDataOrder](/refs/realgrid#filterselectordataorder) | Ordering rules for creating items displayed in the filter Selector |
| [textCategorize](/refs/Interface/FilterAutomatingOptions#textcategorize) | boolean | Whether to classify text |
| [timeCategorize](/refs/Interface/FilterAutomatingOptions#timecategorize) | [TimeCategory](/refs/realgrid#timecategory) | When classifying time, specify classification in hours/minutes/seconds. |
| [userFilterPosition](/refs/Interface/FilterAutomatingOptions#userfilterposition) | [UserFilterPosition](/refs/realgrid#userfilterposition) | Used when displaying filters added by users as well. |

## Events Desc

### dateCategoryCallback

Callback to sort dates

`Type` - [CategoryCallback](/refs/realgrid#categorycallback)

**Remarks:**

See [FilterCategory](/refs/Interface/FilterCategory) for return values and descriptions.

<hr/>

### numberCategoryCallback

Callback to classify numbers

`Type` - [CategoryCallback](/refs/realgrid#categorycallback)

**Remarks:**

See [FilterCategory](/refs/Interface/FilterCategory) for return values and descriptions.

<hr/>

### textCategoryCallback

Callback for sorting strings

`Type` - [CategoryCallback](/refs/realgrid#categorycallback)

**Remarks:**

See [FilterCategory](/refs/Interface/FilterCategory) for return values and descriptions.

<hr/>

## Properties Desc

### dateCategorize

Whether to sort dates

`Type` - boolean

**Remarks:**

When set to `true`, the text is classified by year, quarter, or month based on the formats set.

The number of years must be 2 or more and the number of months must be 7 or more to be classified by year.

The number of months per year must be 7 or more to be classified by quarter.

The total number of days must be 10 or more and the number of months must be 4 or more to be classified as monthly.

If `false`, a filter tab is created for each item in a list format rather than a tree format.

You can create custom categories by specifying [FilterAutomatingOptions.dateCategoryCallback](/refs/Interface/FilterAutomatingOptions#datecategorycallback).

<hr/>

### dateDayFormat

The date format displayed in the entry

`Type` - string

<hr/>

### dateMonthFormat

Month format displayed in entries

`Type` - string

<hr/>

### dateQuarterFormat

Format of branches displayed in items

`Type` - string

<hr/>

### dateYearFormat

Year format displayed in entries

`Type` - string

<hr/>

### filteredDataOnly

Data displayed in FilterSelector

`Type` - boolean

**Remarks:**

If `true`{/* */}, only the filtered data is displayed in the filterSelector, not the entire data.

Applies only to columns where [DataColumn.autoFilter](/refs/Interface/DataColumn#autofilter){/* */} is `true`{/* */}.

<hr/>

### hourFormat

Time format displayed in items

`Type` - string

<hr/>

### lookupDisplay

If Column's lookupDisplay is true, the label is displayed instead of the value.

`Type` - boolean

<hr/>

### minuteFormat

Format of minutes displayed in entries

`Type` - string

<hr/>

### numberCategorize

Whether to classify numbers

`Type` - boolean

**Remarks:**

When `true`, if there are more than 16 duplicated items, they are classified into 4 to 8 sections based on the difference between the maximum and minimum values. If there are less than 15 items or `false`, a filter tab is created for each item in the form of a list rather than a tree. You can do custom classification by specifying [FilterAutomatingOptions.numberCategoryCallback](/refs/Interface/FilterAutomatingOptions#numbercategorycallback).

<hr/>

### secondFormat

Format of seconds displayed in entries

`Type` - string

<hr/>

### selectCallback

Callback called when a filter created by [DataColumn.autoFilter](/refs/Interface/DataColumn#autofilter){/* */} is selected

`Type` - [FilterCallback](/refs/realgrid#filtercallback)

**Remarks:**

Used when the user decides filtering.

<hr/>

### selectorDataOrder

The ordering rule for generating items displayed in the filter selector.

`Type` - [FilterSelectorDataOrder](/refs/realgrid#filterselectordataorder)

**Remarks:**

Specifies the ordering rule used when calculating the data displayed in the filter selector when [filteredDataOnly](/refs/Interface/FilterAutomatingOptions#filtereddataonly) is `true`{/* */} and filters are applied to multiple columns.

<hr/>

### textCategorize

Whether to classify text

`Type` - boolean

**Remarks:**

When `true`, if there are more than 16 items, they are classified into numbers, uppercase letters, lowercase letters, Unicode, and others based on the first character of the string. If there are less than 15 items or `false`, a filter tab is created for each item in the form of a list rather than a tree. You can do custom classification by specifying [FilterAutomatingOptions.textCategoryCallback](/refs/Interface/FilterAutomatingOptions#textcategorycallback).

<hr/>

### timeCategorize

When classifying time, specify classification in hours/minutes/seconds.

`Type` - [TimeCategory](/refs/realgrid#timecategory)

**Remarks:**

If timeCategorize is specified, dateCategorize is not applied.

<hr/>

### userFilterPosition

Used when displaying filters added by the user.

`Type` - [UserFilterPosition](/refs/realgrid#userfilterposition)

<hr/>