Table_GlobalFiltering

Defined in: features/global-filtering/globalFilteringFeature.types.ts:69

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

getGlobalAutoFilterFn#

getGlobalAutoFilterFn: () => FilterFn<TFeatures, TData> | undefined;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:76

Currently, this function returns the built-in includesString filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.

Returns#

FilterFn<TFeatures, TData> | undefined

getGlobalFilterFn#

getGlobalFilterFn: () => FilterFn<TFeatures, TData> | undefined;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:80

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

Returns#

FilterFn<TFeatures, TData> | undefined

resetGlobalFilter#

resetGlobalFilter: (defaultState?) => void;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:86

Resets globalFilter to initialState.globalFilter.

Pass true to ignore initial state and reset to undefined.

Parameters#

defaultState?#

boolean

Returns#

void

setGlobalFilter#

setGlobalFilter: (updater) => void;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:90

Updates global filter state with a next value or updater function.

Parameters#

updater#

any

Returns#

void