GridCellParams Interface
Object passed as parameter in the column GridColDef cell renderer.
Import
import { GridCellParams } from '@material-ui/x-grid';
// or
import { GridCellParams } from '@material-ui/data-grid';
Properties
| Name | Type | Description |
|---|---|---|
| api | any | GridApi that let you manipulate the grid. |
| cellMode | GridCellMode | The mode of the cell. |
| colDef | any | The column of the row that the current cell belongs to. |
| field | string | The column field of the cell that triggered the event |
| formattedValue | GridCellValue | The cell value formatted with the column valueFormatter. |
| getValue | (id: GridRowId, field: string) => GridCellValue | Get the cell value of a row and field. |
| hasFocus | boolean | If true, the cell is the active element. |
| id | GridRowId | The grid row id. |
| isEditable? | boolean | If true, the cell is editable. |
| row | GridRowData | The row model of the row that the current cell belongs to. |
| tabIndex | 0 | -1 | the tabIndex value. |
| value | GridCellValue | The cell value, but if the column has valueGetter, use getValue. |