FilterOptions

View as Markdown

Column Filters (one column) and the Grid Filter (a query across columns).

The filters a user creates are stored on the Layout. These options change how filtering works for the whole grid.

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
clearFiltersOnStartUpbooleanClear Grid and Column Filters when AdapTable loadsfalse
columnFilterOptionsColumnFilterOptionsThe filter row under the column headers, and the operator offered first for each data type.
customInFilterValues(context:CustomInFilterValuesContext<TData>) => Promise<InFilterValueResult> |InFilterValueResultProvide custom values (or sorting / count info) when using the IN operator in Column or Grid Filter
enableFilterOnSpecialColumnsbooleanAllow filtering on Calculated & FreeText columnstrue
isRowFilterable(context:IsRowFilterableContext) => booleanConfigures whether Rows will be evaluated when filtering
showDatePickerbooleanShow Date Picker (or Date Input) in Filter controlstrue
useAdaptableFilteringbooleanUse Adaptable's Column & Grid Filters in preference to AG Grid's filteringtrue

Property Details

clearFiltersOnStartUp

Clear Grid and Column Filters when AdapTable loads

TypeScript
clearFiltersOnStartUp?: boolean;
Default Value

false

Property Value

boolean

columnFilterOptions

The filter row under the column headers, and the operator offered first for each data type.

TypeScript
columnFilterOptions?: ColumnFilterOptions;
Property Value

ColumnFilterOptions

customInFilterValues

Provide custom values (or sorting / count info) when using the IN operator in Column or Grid Filter

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

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

enableFilterOnSpecialColumns

Allow filtering on Calculated & FreeText columns

TypeScript
enableFilterOnSpecialColumns?: boolean;
Default Value

true

Property Value

boolean

isRowFilterable

Configures whether Rows will be evaluated when filtering

TypeScript
isRowFilterable?: (context: IsRowFilterableContext) => boolean;
Property Value

(context:IsRowFilterableContext) => boolean

showDatePicker

Show Date Picker (or Date Input) in Filter controls

TypeScript
showDatePicker?: boolean;
Default Value

true

Property Value

boolean

useAdaptableFiltering

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

TypeScript
useAdaptableFiltering?: boolean;
Default Value

true

Property Value

boolean