filter

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.

Exact input and result types

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

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.

Read related types

• ColumnFilterDecl
• GridFilterDefinition

Feature explanations and examples

• Conditions for each column

  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

  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

  Combine multiple filters, such as text search and a value list, within one column. This differs from enabling separate filters on different columns.