# filter

Built-in filter type or custom filter definition for this column.

Canonical: https://grid.syidax.com/docs/columns/filter/

<a id="meaning"></a>

## What does this API do?

Built-in filter type or custom filter definition for this column.

Set Filter and Multi Filter require Pro. Basic text, number, and date filters are Free.

<a id="contract"></a>

## Exact input and result types

```typescript
filter?: | ColumnFilterDecl
    | string
    | GridFilterDefinition<TData, TValue, unknown, TContext>
```

| Item | Value |
| --- | --- |
| Required | Optional |
| Input type | \| ColumnFilterDecl<br>    \| string<br>    \| GridFilterDefinition<TData, TValue, unknown, TContext> |

<a id="usage"></a>

## Usage flow

Set this on an individual column object in columnDefs. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

<a id="types"></a>

## Read related types

- [ColumnFilterDecl](https://grid.syidax.com/docs/types/ColumnFilterDecl.md)
- [GridFilterDefinition](https://grid.syidax.com/docs/types/GridFilterDefinition.md)

<a id="recipes"></a>

## Feature explanations and examples

- [Conditions for each column](https://grid.syidax.com/docs/features/column-filters.md) — Column filters apply conditions to individual columns. Text, numbers, and dates use different inputs and comparisons; conditions across columns narrow results together.
- [Choose values from a list](https://grid.syidax.com/docs/features/set-filter.md) — This filter lets users choose from distinct, recurring values such as regions or statuses. It presents the available choices more clearly than a Text filter that matches part of a name.
- [Combine multiple filters](https://grid.syidax.com/docs/features/multi-filter.md) — Combine multiple filters, such as text search and a value list, within one column. This differs from enabling separate filters on different columns.