Highcharts Grid
    Preparing search index...

    Interface EditModeContent<E>

    Interface for the edit mode content in a cell. It can be implemented by different types of edit mode contents.

    interface EditModeContent<E extends HTMLElement = HTMLElement> {
        blurHandler?: (e: FocusEvent) => void;
        changeHandler?: (e: Event) => void;
        finishAfterChange: boolean;
        keyDownHandler?: (e: KeyboardEvent) => void;
        rawValue: string;
        value: CellType;
        destroy(): void;
        getMainElement(): E;
    }

    Type Parameters

    • E extends HTMLElement = HTMLElement

    Implemented by

    Index
    blurHandler? changeHandler? finishAfterChange keyDownHandler? rawValue value
    destroy getMainElement
    blurHandler?: (e: FocusEvent) => void

    Blur event handler for the edit mode content that can be overwritten in the Edit Mode Class.

    Type Declaration

      • (e: FocusEvent): void

      • Parameters

        • e: FocusEvent

          The focus event that triggered the blur.

        Returns void

    changeHandler?: (e: Event) => void

    Change event handler for the edit mode content that can be overwritten in the Edit Mode Class.

    Type Declaration

      • (e: Event): void

      • Parameters

        • e: Event

          The event that triggered the change.

        Returns void

    finishAfterChange: boolean

    Indicates whether the edit mode should finish after a change event.

    keyDownHandler?: (e: KeyboardEvent) => void

    Key down event handler for the edit mode content that can be overwritten in the Edit Mode Class.

    Type Declaration

      • (e: KeyboardEvent): void

      • Parameters

        • e: KeyboardEvent

          The keyboard event that triggered the key down.

        Returns void

    rawValue: string

    Raw value of the edit mode cell content, in a string format.

    value: CellType

    Value of the edit mode cell content, parsed according to the column type.

    • Destroys the edit mode content, removing all event listeners and references to the DOM elements.

      Returns void

    • Returns the main element of the edit mode content. In most cases it is an input element used to edit the cell value.

      Returns E

    Settings

    On This Page
    Properties
    Methods