Number filters allow you to filter number data.
The Provided Filters and Simple Filters pages explain the parts of the Number Filter that are the same as the other Provided Filters. This page builds on that and explains some details that are specific to the Number Filter.
Number Filters are configured though the filterParams attribute of the column definition (INumberFilterParams interface):
buttons
Specifies the buttons to be shown in the filter, in the order they should be displayed in. The options are:closeOnApply
(boolean) If the Apply button is present, the filter popup will be closed immediately when the Apply or Reset button is clicked if this is set to true. Default: falsedebounceMs
(number) Overrides the default debounce time in milliseconds for the filter. Defaults are:defaultJoinOperator
By default, the two conditions are combined using AND. You can change this default by setting this property. Options: AND, ORdefaultOption
(string) The default filter option to be selected.filterOptions
Array of filter options to present to the user. See Filter Options.filterPlaceholder
(string) Placeholder text for the filter textboxinRangeInclusive
(boolean) If true, the ‘inRange’ filter option will include values equal to the start and end of the range.includeBlanksInEquals
(boolean) If true, blank (null or undefined) values will pass the ‘equals’ filter option.includeBlanksInGreaterThan
(boolean) If true, blank (null or undefined) values will pass the ‘greaterThan’ and ‘greaterThanOrEqual’ filter options.includeBlanksInLessThan
(boolean) If true, blank (null or undefined) values will pass the ‘lessThan’ and ‘lessThanOrEqual’ filter options.includeBlanksInRange
(boolean) If true, blank (null or undefined) values will pass the ‘inRange’ filter option.numberParser
(Function) Typically used alongside allowedCharPattern, this provides a custom parser to convert the value entered in the filter inputs into a number that can be used for comparisons.readOnly
(boolean) If set to true, disables controls in the filter to mutate its state. Normally this would be used in conjunction with the Filter API. See Read-only Filter UI. Default: falsesuppressAndOrCondition
(boolean) If true, the filter will only allow one condition.Default: false