Interface GridCellEditStartParams<R, V, F>

Params passed to the cellEditStart event.

interface GridCellEditStartParams<R, V, F> {
    api: GridApiCommunity;
    cellMode: GridCellMode;
    colDef: GridStateColDef;
    field: string;
    formattedValue?: F;
    hasFocus: boolean;
    id: GridRowId;
    isEditable?: boolean;
    key?: string;
    reason?: GridCellEditStartReasons;
    row: R;
    rowNode: GridTreeNode;
    tabIndex: -1 | 0;
    value?: V;
}

Type Parameters

Hierarchy (view full)

Properties

api cellMode colDef field formattedValue? hasFocus id isEditable? key? reason? row rowNode tabIndex value?

Properties

api

api: GridApiCommunity

GridApi that let you manipulate the grid.

cellMode

cellMode: GridCellMode

The mode of the cell.

colDef

colDef: GridStateColDef

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

field

field: string

The column field of the cell that triggered the event.

OptionalformattedValue

formattedValue?: F

The cell value formatted with the column valueFormatter.

hasFocus

hasFocus: boolean

If true, the cell is the active element.

id

id: GridRowId

The grid row id.

OptionalisEditable

isEditable?: boolean

If true, the cell is editable.

Optionalkey

key?: string

If the reason is related to a keyboard event, it contains which key was pressed.

Deprecated

No longer needed.

Optionalreason

reason?: GridCellEditStartReasons

The reason for this event to be triggered.

row

row: R

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

rowNode

rowNode: GridTreeNode

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

tabIndex

tabIndex: -1 | 0

the tabIndex value.

Optionalvalue

value?: V

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

Settings

Member Visibility

On This Page

Properties