@revolist/revogrid / ColumnFilterConfig

Type Alias: ColumnFilterConfig

type ColumnFilterConfig: {
  collection: FilterCollection;
  customFilters: Record<string, CustomFilter>;
  disableDynamicFiltering: boolean;
  filterProp: string;
  include: string[];
  localization: FilterLocalization;
  multiFilterItems: MultiFilterItem;
};

Filter configuration for a column. This is the type of the filter property on a column.

Type declaration

Name	Type	Description	Defined in
collection	FilterCollection	The collection of filters to be applied to the column.	src/plugins/filter/filter.types.ts:68
customFilters	Record<string, CustomFilter>	A mapping of custom filter names to custom filter functions.	src/plugins/filter/filter.types.ts:76
disableDynamicFiltering	boolean	Whether or not to disable dynamic filtering. If set to true, the filter will only be applied when the user clicks on the filter button.	src/plugins/filter/filter.types.ts:93
filterProp	string	The property on the column idintifying which has the filter is applied.	src/plugins/filter/filter.types.ts:80
include	string[]	The names of the filters to be included in the filter dropdown.	src/plugins/filter/filter.types.ts:72
localization	FilterLocalization	The localization for the filter dropdown.	src/plugins/filter/filter.types.ts:84
multiFilterItems	MultiFilterItem	Information about the multi-filter items.	src/plugins/filter/filter.types.ts:88

Defined in

src/plugins/filter/filter.types.ts:64