RealGrid2 API
Interface
FilterSelectorOptions

FilterSelectorOptions

Settings for the selection box of the column filter Model

Signature:

export interface FilterSelectorOptions 

Remarks

[grid](/refs /Class/GridBase ), just enter the necessary information when setting it as an option.

Example

grid.setFilteringOptions({
      selector: {
          showButtons: false
      }
});

Properties

PropertyTypeDescription
acceptTextstringText on the OK button in the filter selection box
activeWhenEnterbooleanWhether to activate the searched filter after filter search
allCheckTextstringText in the Select All tab
cancelTextstringWording on the Cancel button in the filter selection box
closeWhenClickbooleanWhether the window is closed when the filter is activated
emptyFilterTextstringWhen creating an automatic filter, no value is found. Phrases in the filter tab
expandCategorybooleanWhether to expand category
filterResetbooleanWhether or not there is a button to reset all filters
filterResetTextstringColumn filter selection initialization text
filtersResetTextstringFilter Reset All Text
maxWidthnumberMaximum width of filter selection window
minWidthnumberMinimum width of the filter selection window. If width is 0, it is not applied.
partialSearchbooleanFilter search box visibility
searchedCheckTextstringPhrases shown instead of selecting all after search
searchIgnoreCasebooleanCase sensitivity when searching filters
searchPlaceholderstringplaceholder for search box
showButtonsbooleanWhether to display the footer button of the selection box of the column filter
showTitlebooleanfilter Whether to display the title area at the top
stylestringclass in filter window
textToTitlebooleanWhether to add filter text as title
titlestringString displayed at the top of the filter selection window
useFilterResetImagebooleanIf set to true, an image will be displayed instead of filterResetText.
widthnumberfilter width

Properties Desc

acceptText

Text on the OK button in the filter selection box

Type - string


activeWhenEnter

Whether to activate the searched filter after filter search

Type - boolean

Remarks:

When you enter enter after a filter search, the searched filter is activated.


allCheckText

Text in the Select All tab

Type - string


cancelText

Text on the Cancel button in the filter selection box

Type - string


closeWhenClick

Whether the window is closed when the filter is activated

Type - boolean

Remarks:

If showButtons is false, the window closes when a filter is selected. If the OK/Cancel button is created by setting showButtons to true, the window closes when the OK/Cancel button is operated.


emptyFilterText

No value when creating an automatic filter Text on the Filter tab

Type - string


expandCategory

Whether to expand category

Type - boolean

Remarks:

When the filter selection box is displayed, the category is displayed in an expanded state.


filterReset

Is there a button to reset all filters?

Type - boolean


filterResetText

Column filter selection initialization text

Type - string


filtersResetText

Filter full reset text

Type - string


maxWidth

Maximum width of filter selection window

Type - number

Remarks:

Specifies the maximum width of the filter selection window. In case of 0, it is not applied.


minWidth

Minimum width of the filter selection window. If width is 0, it is not applied.

Type - number


partialSearch

Filter search box visibility

Type - boolean


searchedCheckText

Phrases displayed instead of selecting all after searching

Type - string


searchIgnoreCase

Case sensitivity when searching filters

Type - boolean

Remarks:

If true, the search is case-insensitive.


searchPlaceholder

placeholder in search box

Type - string


showButtons

Whether to display the footer button of the selection box of the column filter

Type - boolean


showTitle

Filter Whether to display the title area at the top

Type - boolean


style

Filter window class

Type - string


textToTitle

Whether to add filter text as title

Type - boolean

Remarks:

Add the filter's text as the element's title so that a tooltip appears when you mouse over it.


title

String displayed at the top of the filter selection window

Type - string

Remarks:

If not specified, the text of the column is displayed.


useFilterResetImage

If set to true, an image will be displayed instead of filterResetText.

Type - boolean


width

filter width

Type - number

Remarks:

If it is 0, the width specified in the style file is applied. If it is -1, the width of the filter text is calculated and applied. If it is -2, the width of the column is applied. If it is 0 or more, the specified width is applied.