FilterSettingsModel API in JavaScript Grid API control

Interface for a class FilterSettings

Properties

columns

PredicateModel[]

Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.

enableCaseSensitivity

boolean

If enableCaseSensitivity is set to true then searches grid records with exact match based on the filter operator. It will have no effect on number, boolean and Date fields.

ignoreAccent

boolean

If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.

Check the Diacritics filtering.

immediateModeDelay

number

Defines the time delay (in milliseconds) in filtering records when the Immediate mode of filter bar is set.

mode

FilterBarMode

Defines the filter bar modes. The available options are,

• OnEnter: Initiates filter operation after Enter key is pressed.
• Immediate: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.

operators

ICustomOptr

The operators is used to override the default operators in filter menu. This should be defined by type wise (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.

Check the Filter Menu Operator customization.

showFilterBarOperator

boolean

If ‘showFilterBarOperator’ is set to true, then it renders the dropdownlist component to select the operator in filterbar input

showFilterBarStatus

boolean

Shows or hides the filtered status message on the pager.

type

FilterType

Defines options for filtering type. The available options are

• Menu - Specifies the filter type as menu.
• CheckBox - Specifies the filter type as checkbox.
• FilterBar - Specifies the filter type as filterbar.
• Excel - Specifies the filter type as checkbox.