Skip to content

GridCellParams API

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

Demos

Import

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


Object passed as parameter in the column [[GridColDef]] cell renderer.

Properties

GridApi that let you manipulate the grid.

Type:GridApiCommunity


The mode of the cell.

Type:'edit' | 'view'


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

Type:GridStateColDef


The column field of the cell that triggered the event.

Type:string


If true, the cell is the active element.

Type:boolean


The grid row id.

Type:number | string


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

Type:R


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

Type:N


the tabIndex value.

Type:-1 | 0


Optional

The cell value formatted with the column valueFormatter.

Type:F


Optional

If true, the cell is editable.

Type:boolean


Optional

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

Type:V