FilterSettings API in JavaScript TreeGrid API control

Configures the filtering behavior of the TreeGrid, enabling complex data filtering capabilities.

Properties

columns

PredicateModel[]

Specifies the initial filter configuration for TreeGrid columns or retrieves the current filter state.

Defaults to []

hierarchyMode

FilterHierarchyMode

Specifies how the hierarchy should be maintained during filtering:

• Parent: Displays the filtered records along with their parent records.
• Child: Displays the filtered records along with their child records.
• Both: Displays the filtered records with both parent and child records.
• None: Only displays the filtered records.

Defaults to Parent

ignoreAccent

boolean

If set to true, filtering ignores accent characters, making diacritic characters identical to their unaccented versions.

Defaults to false

immediateModeDelay

number

Determines the delay in milliseconds before filtering is triggered in Immediate mode.

Defaults to 1500

mode

FilterBarMode

Determines the mode of the filter bar operation. Options include:

• OnEnter: Filtering is triggered upon pressing the Enter key.
• Immediate: Filtering occurs after a short delay automatically.

Defaults to Syncfusion.EJ2.Grids.FilterBarMode.OnEnter

operators

ICustomOptr

Allows customization of the default operators offered in the filter menu by defining custom operators for string, number, date, and boolean types.

Defaults to null

showFilterBarStatus

boolean

Shows or hides the status message related to filtering actions on the pager.

Defaults to true

type

FilterType

Sets the filtering interface type. Options include:

• Menu: Provides a menu for filtering options.
• FilterBar: Allows direct input filtering in a bar at the top of each column.
• Excel : Specifies the filter type as excel.
• CheckBox : Specifies the filter type as check box.

Defaults to FilterBar