Interface ControlledFilterModel

Definition

export interface ControlledFilterModel

Comments

Object that enables the filtering feature on a grid or table in an externally controllable manner.

Properties

NameOptionalDefinitionComment
filterTableCaptiontruestring

Caption for the filter settings table element.

@defaultValue

undefined - no caption will be displayed

setTableFilterStatefalse(state: EditableFilterState) => void

Update callback function for the tableFilterState property. This function is called when the user submits the filter settings form.

tableFilterStatefalseEditableFilterState

State object that represents the filters currently being applied to the table or grid.

typetrue"controlled"

A type discriminator.