ColumnFilterOptions
Options for managing Column Filtering in AdapTable
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| defaultArrayColumnFilter | StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'>) | Default filter type for array Columns ('textArray', 'numberArray', etc.) | In |
| defaultDateColumnFilter | StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'>) | Default filter type for date Columns | On |
| defaultNumericColumnFilter | StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'>) | Default filter type for numeric Columns | Equals |
| defaultTextColumnFilter | StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'>) | Default filter type for text Columns | Contains |
| hideQuickFilterDropdown | (adaptableColumnContext:AdaptableColumnContext<TData>) => boolean | Hides Dropdown in Quick Filter Bar for a given Column | undefined |
| indicateFilteredColumns | boolean | Make Column Header distinctive for filtered columns, helps users see currently filtered columns | true |
| manuallyApplyColumnFilter | boolean | ((context:AdaptableColumnContext) => boolean) | Manually apply Column Filters; an Apply Filter button is displayed and Quick Filter is disabled | false |
| quickFilterDebounce | number | Time to wait (in ms) before Filter Bar reacts to new value | 250 |
| quickFilterHeight | number | Height of Quick Filter Bar (if not provided, AG Grid default is used) | null |
| quickFilterWildcards | Partial<Record<SystemAlertPredicateId, string[]>> | Shortcut Keys to activate a Quick Filter Predicate | |
| showQuickFilter | boolean | Display Quick Filter Bar between Column Header and Grid (provided its been setup) | true |
Property Details
defaultArrayColumnFilter
Default filter type for array Columns ('textArray', 'numberArray', etc.)
defaultArrayColumnFilter?: StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'>);Default Value
In
Property Value
StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'>)
defaultDateColumnFilter
Default filter type for date Columns
defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'>);Default Value
On
Property Value
StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'>)
defaultNumericColumnFilter
Default filter type for numeric Columns
defaultNumericColumnFilter?: StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'>);Default Value
Equals
Property Value
StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'>)
defaultTextColumnFilter
Default filter type for text Columns
defaultTextColumnFilter?: StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'>);Default Value
Contains
Property Value
StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'> | ((adaptableColumnContext:DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'>)
hideQuickFilterDropdown
Hides Dropdown in Quick Filter Bar for a given Column
hideQuickFilterDropdown?: (adaptableColumnContext: AdaptableColumnContext<TData>) => boolean;Default Value
undefined
Property Value
(adaptableColumnContext:AdaptableColumnContext<TData>) => boolean
indicateFilteredColumns
Make Column Header distinctive for filtered columns, helps users see currently filtered columns
indicateFilteredColumns?: boolean;Default Value
true
Property Value
boolean
manuallyApplyColumnFilter
Manually apply Column Filters; an Apply Filter button is displayed and Quick Filter is disabled
manuallyApplyColumnFilter?: boolean | ((context: AdaptableColumnContext) => boolean);Default Value
false
Property Value
boolean | ((context:AdaptableColumnContext) => boolean)
quickFilterDebounce
Time to wait (in ms) before Filter Bar reacts to new value
quickFilterDebounce?: number;Default Value
250
Property Value
number
quickFilterHeight
Height of Quick Filter Bar (if not provided, AG Grid default is used)
quickFilterHeight?: number;Default Value
null
Property Value
number
quickFilterWildcards
Shortcut Keys to activate a Quick Filter Predicate
quickFilterWildcards?: Partial<Record<SystemAlertPredicateId, string[]>>;Default Value
Property Value
Partial<Record<SystemAlertPredicateId, string[]>>
showQuickFilter
Display Quick Filter Bar between Column Header and Grid (provided its been setup)
showQuickFilter?: boolean;Default Value
true
Property Value
boolean