Function: table_resetGlobalFilter()#

function table_resetGlobalFilter<TFeatures, TData>(table, defaultState?): void;

function table_resetGlobalFilter<TFeatures, TData>(table, defaultState?): void;

Defined in: features/global-filtering/globalFilteringFeature.utils.ts:108

Resets globalFilter to the configured initial state or feature default.

With no argument, the reset clones table.initialState.globalFilter. Passing true ignores initial state and resets to undefined.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Parameters#

table#

Table_Internal<TFeatures, TData>

defaultState?#

boolean

Returns#

void

Example#

table_resetGlobalFilter(table)
table_resetGlobalFilter(table, true)

table_resetGlobalFilter(table)
table_resetGlobalFilter(table, true)