Class CellEditing

The class that handles the manual editing of cells in the data grid.

Index

Constructors

Properties

editedCell? editModeContent? viewport

Methods

setA11yAttributes startEditing stopEditing

Constructors

constructor

new CellEditing(viewport: Table): CellEditing
Parameters
- viewport: Table
Returns CellEditing

Properties

`Optional`editedCell

editedCell?: TableCell

The cell being currently edited.

`Optional`editModeContent

editModeContent?: EditModeContent<HTMLElement>

The content of the cell edit mode, which represents a context containing the input field or similar element for applying changes to the cell value.

`Readonly`viewport

viewport: Table

The viewport the edited cells are part of.

Methods

setA11yAttributes

setA11yAttributes(valid: boolean): void
Parameters
- valid: boolean
Returns void

startEditing

startEditing(cell: TableCell): void
Turns the cell into an editable input field.
Parameters
- cell: TableCell
  The cell that is to be edited.
Returns void

stopEditing

stopEditing(submit?: boolean): boolean
Stops the editing of the cell.
Parameters
- submit: boolean = true
  Whether to save the value of the input to the cell. Defaults to true.
Returns boolean
Returns true if the cell was successfully stopped editing.