Interface ICellEditorController

An object which manages cell editing.

interface ICellEditorController {
    cancel(): void;
    edit(cell, options?): boolean;
    setEditor(identifier, editor): void;
}

Implemented by

CellEditorController

Index

Methods

cancel edit setEditor

Methods

cancel

cancel(): void
Cancel editing.

Returns void
- Defined in datagrid/src/celleditorcontroller.ts:69

edit

edit(cell, options?): boolean
Start editing a cell.
Parameters
- cell: CellEditor.CellConfig
  The object holding cell configuration data.
- Optional options: ICellEditOptions
  The cell editing options.
Returns boolean
- Defined in datagrid/src/celleditorcontroller.ts:65

setEditor

setEditor(identifier, editor): void
Override cell editor for the cells matching the identifier.
Parameters
- identifier: EditorOverrideIdentifier
  Cell identifier to use when matching cells. if identifier is a CellDataType, then cell matching is done using data type of the cell, if identifier is a Metadata, then partial match of the cell metadata with identifier is used for match, if identifier is 'default' then override is used as default editor when no other editor is found suitable
- editor: ICellEditor | Resolver
  The cell editor to use or resolver to use to get an editor for matching cells.
Returns void
- Defined in datagrid/src/celleditorcontroller.ts:54