Interface CellEditorContextIf

What a CellEditorIf gets when it opens (Excel-style editing, TableOptionsIf.editing).

Since

1.1.99

Hierarchy

  • CellEditorContextIf

Properties

ariaLabel columnDef? columnIndex direction domService input mode row rowIndex textSelection typedText? value

Methods

cancel commit inputChanged

Properties

Readonly ariaLabel

ariaLabel: string

Accessible name of the editor (the column label).

Optional Readonly columnDef

columnDef?: ColumnDefIf

The column definition, if the model has one.

Readonly columnIndex

columnIndex: number

Model column index.

Readonly direction

direction: "ltr" | "rtl"

Writing direction of the table.

Readonly domService

domService: DomServiceIf

DOM access of the table.

Readonly input

input: string

The value as editor text, e.g. "42" – the editor starts with it unless typedText is set.

Readonly mode

mode: CellEditMode

"enter" (typed) or "edit" (F2, Enter, double click).

Readonly row

row: unknown

The row object (the data of a tree row), undefined for models without objects.

Readonly rowIndex

rowIndex: number

Display row index of the edited body cell.

Readonly textSelection

textSelection: "all" | "end"

"all": select the text, "end": caret at the end (F2 is always "end").

Optional Readonly typedText

typedText?: string

The character typed to open the editor ("enter" mode); it replaces the content.

Readonly value

value: unknown

The current value of the cell (a pending value in a batch edit).

Methods

cancel

commit

inputChanged

Settings

Member Visibility

Theme

On This Page