Class OptionCellEditor

Cell editor for option cells.

It supports multiple option selection. If cell metadata contains type attribute 'array', then it behaves as a multi select. In that case cell data is expected to be list of string values.

Hierarchy (view full)



_isMultiSelect: boolean = false

Cell configuration data for the cell being edited.

editorContainer: HTMLDivElement

The div element used to contain and position editor widget.

inputChanged: Signal<OptionCellEditor, void> = ...

A signal emitted when input changes.

onCancel?: (() => void)

Callback method to call on cell edit cancel.

Type declaration

    • (): void
    • Returns void

onCommit?: ((response) => void)

Callback method to call on cell edit commit.

Type declaration

validator: undefined | ICellInputValidator

Cell input validator to use for the cell being edited.

validityNotification: null | Notification = null

Notification popup used to show validation error messages.

viewportOccluder: HTMLDivElement

The div element used to prevent editor widget overflow beyond grid viewport.


  • get isDisposed(): boolean
  • Whether the cell editor is disposed.

    Returns boolean

  • get validInput(): boolean
  • Whether the value input is valid.

    Returns boolean


  • Set validity flag.


    • valid: boolean

      Whether the input is valid.

    • message: string = ''

      Notification message to show.

      If message is set to empty string (which is the default) existing notification popup is removed if any.

    Returns void