API REFERENCE

getFilterModel

Reads combined state across current filter families.

What does this API do?

Reads combined state across current filter families.

Exact input and result types

typescript
getFilterModel(): Promise<SyGridFilterSlice>
ArgumentsRequiredType

The return type is Promise<SyGridFilterSlice>.

Usage flow

After registering and initializing the Grid element, call grid.getFilterModel(…). 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