API REFERENCE
setFilterModel
Applies a validated combined filter model. null clears all filter families; inspect reports for invalid models.
What does this API do?
Applies a validated combined filter model. null clears all filter families; inspect reports for invalid models.
Exact input and result types
setFilterModel(model: SyGridFilterSlice | null): Promise<FilterSliceApplyResult['report']>| Arguments | Required | Type |
|---|---|---|
| model | Required | SyGridFilterSlice | null |
The return type is Promise<FilterSliceApplyResult['report']>.
Usage flow
After registering and initializing the Grid element, call grid.setFilterModel(…). 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.