Skip to content

Overview

Represents a cell editor in a grid. It manages the editing of cells by handling events, saving data, rendering the editor UI, and managing the lifecycle of the editor instance.

Properties

PropertyAttributeDescriptionTypeDefault
additionalDataadditional-dataAdditional data to pass to rendereranyundefined
column--Column data for editor.null | { prop: ColumnProp; model: DataType<any>; column: ColumnRegular; rowIndex: number; colIndex: number; colType: DimensionCols; type: DimensionRows; data: DataType<any>[]; value?: any; }undefined
editCell--Cell to edit data.EditCellStore & BeforeSaveDataDetailsundefined
editor--Custom editors register((column: ColumnDataSchemaModel, save: (value?: any, preventFocus?: boolean | undefined) => void, close: (focusNext?: boolean | undefined) => void) => EditorBase) | EditorCtrConstructible | nullundefined
saveOnClosesave-on-closeSave on editor close. Defines if data should be saved on editor close.booleanfalse

Events

EventDescriptionType
celleditCell edit eventCustomEvent<{ rgRow: number; rgCol: number; type: DimensionRows; prop: ColumnProp; val: any; preventFocus?: boolean | undefined; }>
closeeditClose editor event pass true if requires focus nextCustomEvent<boolean | undefined>

Methods

beforeDisconnect() => Promise<void>

Before editor got disconnected. Can be triggered multiple times before actual disconnect.

Returns

Type: Promise<void>

cancelChanges() => Promise<void>

Cancel pending changes flag. Editor will be closed without autosave.

Returns

Type: Promise<void>

Dependencies

Used by

Graph


Built with ❤️ by Revolist OU

Revogrid is a powerful data grid library made by Revolist OU.