Column_ColumnFiltering

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getAutoFilterFn

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

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

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

Returns

FilterFn<TFeatures, TData>

getCanFilter

getCanFilter: () => boolean;

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

Checks whether this accessor column can currently be column-filtered.

Returns

boolean

getFilterFn

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

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

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

Returns

FilterFn<TFeatures, TData>

getFilterIndex

getFilterIndex: () => number;

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

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

Returns

number

getFilterValue

getFilterValue: () => unknown;

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

Reads this column's current value from state.columnFilters.

Returns

unknown

getIsFiltered

getIsFiltered: () => boolean;

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

Checks whether this column has an active entry in state.columnFilters.

Returns

boolean

setFilterValue

setFilterValue: (updater) => void;

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

Adds, updates, or removes this column's filter value.

Updater functions receive the previous filter value. Values that satisfy the filter function's autoRemove rule are removed from filter state.

Parameters

updater

any

Returns

void