API REFERENCE
getColumnFilterInstance
Queries a column's custom filter instance. May return null if absent or not yet created.
What does this API do?
Queries a column's custom filter instance. May return null if absent or not yet created.
Exact input and result types
getColumnFilterInstance<TColumnValue = unknown, TModel = unknown>(columnId: string): Promise<
GridFilterInstance<GridData, TColumnValue, TModel, unknown> | null
>| Arguments | Required | Type |
|---|---|---|
| columnId | Required | string |
The return type is `Promise< GridFilterInstance<GridData, TColumnValue, TModel, unknown> | null >`.
Usage flow
After registering and initializing the Grid element, call grid.getColumnFilterInstance(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Read related types
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.