Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Table API Reference
Column API Reference
Row API Reference
Cell API Reference
Header API Reference
Features API Reference
Legacy API Reference
Enterprise
Features API Reference

Table_GlobalFiltering

Interface: Table_GlobalFiltering<TFeatures, TData>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getGlobalAutoFilterFn()

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

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

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()

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

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

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

Returns

FilterFn<TFeatures, TData> | undefined


resetGlobalFilter()

ts
resetGlobalFilter: (defaultState?) => void;

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

Resets the globalFilter state to initialState.globalFilter, or true can be passed to force a default blank state reset to undefined.

Parameters

defaultState?

boolean

Returns

void


setGlobalFilter()

ts
setGlobalFilter: (updater) => void;

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

Sets or updates the state.globalFilter state.

Parameters

updater

any

Returns

void