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

TFeatures extends TableFeatures

TData extends RowData

getAutoFilterFn: () => FilterFn<TFeatures, TData>;

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

Returns an automatically calculated filter function for the column based off of the columns first known value.

FilterFn<TFeatures, TData>

getCanFilter: () => boolean;

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

Returns whether or not the column can be column filtered.

boolean

getFilterFn: () => FilterFn<TFeatures, TData>;

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

Returns the filter function (either user-defined or automatic, depending on configuration) for the columnId specified.

FilterFn<TFeatures, TData>

getFilterIndex: () => number;

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

Returns the index (including -1) of the column filter in the table's state.columnFilters array.

number

getFilterValue: () => unknown;

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

Returns the current filter value for the column.

unknown

getIsFiltered: () => boolean;

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

Returns whether or not the column is currently filtered.

boolean

setFilterValue: (updater) => void;

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

A function that sets the current filter value for the column. You can pass it a value or an updater function for immutability-safe operations on existing values.

any

void