Filters

The filters feature provides methods and state for filtering table rows based on column values. These properties are available on the table instance when using the column filtering feature. See the column filtering guide for usage examples and configuration details.

Prop	Type
getFilteredRowModel Returns the row model for the table after `column` filtering has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getGlobalAutoFilterFn 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.	() => FilterFn<TData>
getGlobalFacetedMinMaxValues Returns the faceted min and max values for the global filter.	() => [ number, number, ]
getGlobalFacetedRowModel Returns the row model for the table after global filtering has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getGlobalFacetedUniqueValues Returns the faceted unique values for the global filter.	() => Map< any, number >
getGlobalFilterFn Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.	() => FilterFn<TData>
getPreFilteredRowModel Returns the row model for the table before any `column` filtering has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
resetColumnFilters Resets the `columnFilters` state to `initialState.columnFilters`, or `true` can be passed to force a default blank state reset to `[]`.	( defaultState?: boolean, ) => void
resetGlobalFilter Resets the `globalFilter` state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.	( defaultState?: boolean, ) => void
setColumnFilters Sets or updates the `state.columnFilters` state.	( updater: \| T \| ((old: T) => T), ) => void
setGlobalFilter Sets or updates the `state.globalFilter` state.	( updater: any, ) => void

getFilteredRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model for the table after column filtering has been applied.

getGlobalAutoFilterFn

Type

() => FilterFn<TData>

Description

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.

getGlobalFacetedMinMaxValues

Type

() => [
  number,
  number,
]

Description

Returns the faceted min and max values for the global filter.

getGlobalFacetedRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model for the table after global filtering has been applied.

getGlobalFacetedUniqueValues

Type

() => Map<
  any,
  number
>

Description

Returns the faceted unique values for the global filter.

getGlobalFilterFn

Type

() => FilterFn<TData>

Description

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

getPreFilteredRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model for the table before any column filtering has been applied.

resetColumnFilters

Type

(
  defaultState?: boolean,
) => void

Description

Resets the columnFilters state to initialState.columnFilters, or true can be passed to force a default blank state reset to [].

resetGlobalFilter

Type

(
  defaultState?: boolean,
) => void

Description

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

setColumnFilters

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Sets or updates the state.columnFilters state.

setGlobalFilter

Type

(
  updater: any,
) => void

Description

Sets or updates the state.globalFilter state.

Expanded

Grouping