RealGrid2 API
Interface
FilteringOptions

FilteringOptions

Setting model related to column filtering

Signature:

export interface FilteringOptions

Remarks

When setting it as an option in Grid, you only need to enter the necessary information.

Example

grid.setFilteringOptions({enabled: false});

Properties

PropertyTypeDescription
automatingFilterAutomatingOptionsSetting model for automatic filtering
commitBeforeFilteringbooleanWhether to commit before filtering
enabledbooleanWhether the filter box can be displayed by clicking the filter handle or indicator head
handleVisibilityHandleVisibilityHow to display filter handles
includeParentItembooleanWhether to also display parent rows of data rows retrieved from TreeView
selectorFilterSelectorOptionsSet model for filter selection box
toastToastOptionsToast-related settings

Properties Desc

automating

Settings model for automatic filtering

Type - FilterAutomatingOptions

Remarks:

It follows the FilterAutomatingOptions model.


commitBeforeFiltering

Whether to commit before filtering

Type - boolean


enabled

Whether the filter box can be displayed by clicking the filter handle or indicator head.

Type - boolean


handleVisibility

How filter handles are displayed

Type - HandleVisibility


includeParentItem

Whether to also display the parent row of the data row retrieved from the TreeView.

Type - boolean


selector

Settings model for filter selection box

Type - FilterSelectorOptions

Remarks:

It follows the FilterSelectorOptions model.


toast

Toast-related settings

Type - ToastOptions

Remarks:

It follows the ToastOptions model.