FilterFn

Defined in: features/column-filtering/columnFilteringFeature.types.ts:60

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

FilterFn(
   row,
   columnId,
   filterValue,
   addMeta?): boolean;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:64

Parameters#

row#

Row<TFeatures, TData>

columnId#

string

filterValue#

any

addMeta?#

(meta) => void

Returns#

boolean

Properties#

autoRemove?#

optional autoRemove?: ColumnFilterAutoRemoveTestFn<TFeatures, TData, unknown>;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:79

Removes the filter from state.columnFilters when the filter value fails this test (e.g. empty strings for text filters).

When provided, this test is authoritative: values it keeps stay in filter state even when they are empty strings, which the default heuristic would otherwise remove. An undefined filter value always clears the filter regardless.

resolveDataValue?#

optional resolveDataValue?: TransformDataValueFn;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:92

Normalizes each row's value before it is compared against the filter value. Only honored by filter functions built with constructFilterFn (including all built-in filter functions).

resolveFilterValue?#

optional resolveFilterValue?: TransformFilterValueFn<TFeatures, TData, unknown>;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:86

Normalizes the filter value before filtering runs.

The table applies this once per filter (not per row) and passes the resolved value to the filter function as filterValue.