FilterOptions
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.
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| clearFiltersOnStartUp | boolean | Clear Grid and Column Filters when AdapTable loads | false |
| columnFilterOptions | ColumnFilterOptions | The filter row under the column headers, and the operator offered first for each data type. | |
| customInFilterValues | (context:CustomInFilterValuesContext<TData>) => Promise<InFilterValueResult> |InFilterValueResult | Provide custom values (or sorting / count info) when using the IN operator in Column or Grid Filter | |
| enableFilterOnSpecialColumns | boolean | Allow filtering on Calculated & FreeText columns | true |
| isRowFilterable | (context:IsRowFilterableContext) => boolean | Configures whether Rows will be evaluated when filtering | |
| showDatePicker | boolean | Show Date Picker (or Date Input) in Filter controls | true |
| useAdaptableFiltering | boolean | Use Adaptable's Column & Grid Filters in preference to AG Grid's filtering | true |
Property Details
clearFiltersOnStartUp
Clear Grid and Column Filters when AdapTable loads
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.
columnFilterOptions?: ColumnFilterOptions;Property Value
customInFilterValues
Provide custom values (or sorting / count info) when using the IN operator 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
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