GridFilterModel API

Model describing the filters to apply to the grid.

Demos

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

Pass filters to the grid

Import

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

Properties

items

Type:GridFilterItem[]

Default:[]

logicOperatorOptional

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

Type:GridLogicOperator

Default:GridLogicOperator.And

quickFilterExcludeHiddenColumnsOptional

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

Type:boolean

Default:true

quickFilterLogicOperatorOptional

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

Type:GridLogicOperator

Default:GridLogicOperator.And

quickFilterValuesOptional

values used to quick filter rows

Type:any[]

Default:[]