API REFERENCE

getColumnFilterModel

Reads one column's current filter model.

What does this API do?

Reads one column's current filter model.

Exact input and result types

typescript
getColumnFilterModel<TModel = unknown>(columnId: string): Promise<TModel | null>
ArgumentsRequiredType
columnIdRequiredstring

The return type is Promise<TModel | null>.

Usage flow

After registering and initializing the Grid element, call grid.getColumnFilterModel(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Feature explanations and examples