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


## ColumnFilter

Setting information related to column filtering

**Signature:**

```typescript
export interface ColumnFilter
```

## Remarks

Used in filter-related methods such as [GridBase.onFilteringChanged](/refs/Class/GridBase#onfilteringchanged) or [GridBase.getColumnFilter()](/refs/Class/GridBase#getcolumnfilter).

When it is a format for setting, such as [GridBase.setColumnFilters()](/refs/Class/GridBase#setcolumnfilters), you only need to enter the information you want.

## Events

| Property | Type | Description |
| --- | --- | --- |
| [callback](/refs/Interface/ColumnFilter#callback) | [FilterCallback](/refs/realgrid#filtercallback) | Callback to determine filter |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [active](/refs/Interface/ColumnFilter#active) | boolean | Whether filter is activated |
| [criteria](/refs/Interface/ColumnFilter#criteria) | string | expression |
| [description](/refs/Interface/ColumnFilter#description) | string | Description |
| [name](/refs/Interface/ColumnFilter#name) | string | name |
| [tag](/refs/Interface/ColumnFilter#tag) | string | Tags |
| [text](/refs/Interface/ColumnFilter#text) | string | String displayed in filter selection box |
| [visible](/refs/Interface/ColumnFilter#visible) | boolean | Visibility |

## Events Desc

### callback

Callback to determine filter

**Remarks:**

`true`{/* */}: When filtering, `false`{/* */}: When filtering is excluded.

<hr/>

## Properties Desc

### active

Whether filter is activated

`Type` - boolean

<hr/>

### criteria

expression

`Type` - string

**Remarks:**

Either criteria or callback must be specified.

<hr/>

### description

explanation

`Type` - string

<hr/>

### name

name

`Type` - string

<hr/>

### tag

tag

`Type` - string

<hr/>

### text

String displayed in filter selection box

`Type` - string

**Remarks:**

If `null`{/* */}, `name`{/* */} is displayed.

<hr/>

### visible

Visibility

`Type` - boolean

<hr/>