FilterOptions

Options for managing Column & Grid Filters in AdapTable

export interface

Properties

Property Details

clearFiltersOnStartUp

Clear Grid and Column Filters when AdapTable loads

clearFiltersOnStartUp?: boolean;

Default Value

true

Property Value

boolean

columnFilterOptions

Options for managing Column Filters

columnFilterOptions?: ColumnFilterOptions;

Property Value

ColumnFilterOptions

customInFilterValues

Provide custom values (or sorting / count info) when using In Predicate in Column or Grid Filter

customInFilterValues?: (context: CustomInFilterValuesContext<TData>) => Promise<InFilterValueResult> | InFilterValueResult;

Property Value

(context:CustomInFilterValuesContext<TData>) => Promise<InFilterValueResult> |InFilterValueResult

enableFilterOnSpecialColumns

Allow filtering on Calculated & FreeText columns

enableFilterOnSpecialColumns?: boolean;

Default Value

true

Property Value

boolean

filterActionOnDataChange

When to re-filter grid after data changes: 'Always', 'Never' or 'Throttle' (with a delay value)

filterActionOnDataChange?: FilterActionOnDataChange;

Default Value

'Always'

Property Value

FilterActionOnDataChange

gridFilterOptions

Options for managing the Grid Filter

gridFilterOptions?: GridFilterOptions;

Property Value

GridFilterOptions

isRowFilterable

Configures whether Rows will be evaluated when filtering

isRowFilterable?: (context: IsRowFilterableContext) => boolean;

Property Value

(context:IsRowFilterableContext) => boolean

showDatePicker

Show Date Picker (or Date Input) in Filter controls

showDatePicker?: boolean;

Default Value

true

Property Value

boolean

useAdaptableFiltering

Use Adaptable's Column & Grid Filters in preference to AG Grid's filtering

useAdaptableFiltering?: boolean;

Default Value

true

Property Value

boolean