GridFilterModel API

Extended documentation for the GridFilterModel interface with detailed information on the module's properties and available APIs.

Demos

For examples and details on the usage, check the following pages:

- [Pass filters to the grid](/x/react-data-grid/filtering/#pass-filters-to-the-data-grid)

Import

import { GridFilterModel } from '@mui/x-data-grid';
// or
import { GridFilterModel } from '@mui/x-data-grid-pro';
// or
import { GridFilterModel } from '@mui/x-data-grid-premium';

Model describing the filters to apply to the grid.

Properties

items

Type:GridFilterItem[]

Default:[]

logicOperator

Optional

- `GridLogicOperator.And`: the row must pass all the filter items. - `GridLogicOperator.Or`: the row must pass at least on filter item.

Type:'and' | 'or'

Default:GridLogicOperator.And

quickFilterExcludeHiddenColumns

Optional

If `false`, the quick filter will also consider cell values from hidden columns.

Type:boolean

Default:true

quickFilterLogicOperator

Optional

- `GridLogicOperator.And`: the row must pass all the values. - `GridLogicOperator.Or`: the row must pass at least one value.

Type:'and' | 'or'

Default:GridLogicOperator.And

quickFilterValues

Optional

values used to quick filter rows

Type:any[]

Default:[]