Example of Default Filtering in React Tree Grid Component

/
/
Filtering

This sample demonstrates the default support of filterbar in Tree Grid.In this sample, type the value in the filterbar and press enter to filter particular column.The filtering is based on hierarchy mode.

More Details...

Loading....
Description

The filtering feature enables the user to view the reduced amount of records based on filter criteria. It can be enabled by setting allowFiltering property as true. A filter bar row will be rendered next to header which allows the end-users to filter data by entering text within its cells.

Filterbar uses two modes which specifies how to start filtering. They are,

  • OnEnter - Enabled by default, filter will be initiated after pressing Enter key.
  • Immediate - Filter will start after user ends typing. This uses a time delay of 1500ms to initiate filter after use stops typing. It can be overridden using the filterSettings->immediateModeDelay property.

Tree Grid provides support for a set of filtering modes with hierarchyMode property. The below are the type of filter mode available in Tree Grid.

  • Parent - This is the default filter hierarchy mode in Tree Grid. The filtered records are displayed with its parent records, if the filtered records not have any parent record then the filtered record only displayed.
  • Child - The filtered records are displayed with its child record, if the filtered records do not have any child record then only the filtered records are displayed.
  • Both - The filtered records are displayed with its both parent and child record. If the filtered records do not have any parent and child record then only the filtered records are displayed.
  • None - Only the filtered records are displayed.

Injecting Module:

Tree Grid features are segregated into individual feature-wise modules. To use filtering feature, we need to inject Filter module into the services.

More information on the filter configuration can be found in this documentation section.