Skip to content

GridCellParams API

Object passed as parameter in the column GridColDef cell renderer.

Demos

Import

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

Properties

api

GridApi that let you manipulate the grid.

Type:GridApiCommunity

cellMode

The mode of the cell.

Type:GridCellMode

colDef

The column of the row that the current cell belongs to.

Type:GridStateColDef

field

The column field of the cell that triggered the event.

Type:string

hasFocus

If true, the cell is the active element.

Type:boolean

id

The grid row id.

Type:GridRowId

row

The row model of the row that the current cell belongs to.

Type:GridRowModel<R>

rowNode

The node of the row that the current cell belongs to.

Type:N

tabIndex

the tabIndex value.

Type:0 | -1

formattedValueOptional

The cell value formatted with the column valueFormatter.

Type:F | undefined

isEditableOptional

If true, the cell is editable.

Type:boolean

valueOptional

The cell value.
If the column has valueGetter, use params.row to directly access the fields.

Type:V | undefined