apex-grid
    Preparing search index...

    Interface BaseApexEditorContext<T, K>

    Context object handed to a custom editor template.

    Includes the cell's current value plus commit / cancel callbacks so the editor can hand its result back to the grid. The custom editor is also responsible for forwarding Enter / Escape to those callbacks.

    interface BaseApexEditorContext<T extends object, K extends Keys<T> = Keys<T>> {
        cancel: () => void;
        column: ColumnConfiguration<T, K>;
        commit: (value: PropertyType<T, K>) => Promise<boolean>;
        parent: ApexGridCell<T>;
        row: ApexGridRow<T>;
        value: PropertyType<T, K>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    cancel column commit parent row value

    Properties

    cancel: () => void

    Discards the in-progress edit and exits edit mode.

    column: ColumnConfiguration<T, K>

    The current configuration for the column.

    commit: (value: PropertyType<T, K>) => Promise<boolean>

    Commits value as the new cell value, going through the cancellable cellValueChanging event and then cellValueChanged.

    Type Declaration

      • (value: PropertyType<T, K>): Promise<boolean>

      • Parameters

        Returns Promise<boolean>

        true if the value was applied, false if cancelled.

    parent: ApexGridCell<T>

    The cell element parent of the template.

    row: ApexGridRow<T>

    The row element containing the cell.

    value: PropertyType<T, K>

    The value from the data source for this cell.

    Settings

    Member Visibility

    On This Page

    Properties