apex-grid
    Preparing search index...

    Interface ApexGridEventMap<T>

    Events for the apex-grid.

    interface ApexGridEventMap<T extends object> {
        cellValueChanged: CustomEvent<ApexCellValueChangedEvent<T>>;
        cellValueChanging: CustomEvent<ApexCellValueChangingEvent<T>>;
        columnMoved: CustomEvent<ApexColumnMovedEvent<T>>;
        columnMoving: CustomEvent<ApexColumnMovingEvent<T>>;
        columnPinned: CustomEvent<ApexColumnPinnedEvent<T>>;
        columnPinning: CustomEvent<ApexColumnPinningEvent<T>>;
        filtered: CustomEvent<ApexFilteredEvent<T>>;
        filtering: CustomEvent<ApexFilteringEvent<T>>;
        pageChanged: CustomEvent<ApexPageChangedEvent>;
        pageChanging: CustomEvent<ApexPageChangingEvent>;
        quickFilterChanged: CustomEvent<ApexQuickFilterChangedEvent>;
        quickFilterChanging: CustomEvent<ApexQuickFilterChangingEvent>;
        rowEditEnded: CustomEvent<ApexRowEditEndedEvent>;
        rowEditStarted: CustomEvent<ApexRowEditStartedEvent>;
        rowExpanded: CustomEvent<ApexRowExpandedEvent<T>>;
        rowExpanding: CustomEvent<ApexRowExpandingEvent<T>>;
        rowSelected: CustomEvent<ApexRowSelectedEvent<T>>;
        rowSelecting: CustomEvent<ApexRowSelectingEvent<T>>;
        sorted: CustomEvent<SortExpression<T, keyof T>>;
        sorting: CustomEvent<SortExpression<T, keyof T>>;
        treeRowExpanded: CustomEvent<ApexTreeRowExpandedEvent<T>>;
        treeRowExpanding: CustomEvent<ApexTreeRowExpandingEvent<T>>;
    }

    Type Parameters

    • T extends object
    Index

    Events

    cellValueChanged cellValueChanging columnMoved columnMoving columnPinned columnPinning filtered filtering pageChanged pageChanging quickFilterChanged quickFilterChanging rowEditEnded rowEditStarted rowExpanded rowExpanding rowSelected rowSelecting sorted sorting treeRowExpanded treeRowExpanding

    Events

    cellValueChanged: CustomEvent<ApexCellValueChangedEvent<T>>

    Emitted after a cell value has been committed.

    cellValueChanging: CustomEvent<ApexCellValueChangingEvent<T>>

    Emitted before a cell value is committed.

    Cancellable — preventDefault() rolls back the candidate value. In row edit mode the event still fires per-cell at commit time.

    columnMoved: CustomEvent<ApexColumnMovedEvent<T>>

    Emitted after a column has been moved.

    columnMoving: CustomEvent<ApexColumnMovingEvent<T>>

    Emitted before a column is moved through the UI or ApexGrid.moveColumn.

    Cancellable — calling preventDefault() aborts the move. The event detail carries the source column key, its current array index, the target column key and the drop position.

    columnPinned: CustomEvent<ApexColumnPinnedEvent<T>>

    Emitted after a column's pin position change has been applied.

    columnPinning: CustomEvent<ApexColumnPinningEvent<T>>

    Emitted before a column's pin position changes.

    Cancellable — calling preventDefault() aborts the change.

    filtered: CustomEvent<ApexFilteredEvent<T>>

    Emitted when a filter operation initiated through the UI has completed. Returns the filter state for the affected column.

    filtering: CustomEvent<ApexFilteringEvent<T>>

    Emitted when filtering is initiated through the UI.

    The event is cancellable which prevents the operation from being applied. The expression can be modified prior to the operation running.

    pageChanged: CustomEvent<ApexPageChangedEvent>

    Emitted after a page or page-size change has been applied and the pipeline has run.

    pageChanging: CustomEvent<ApexPageChangingEvent>

    Emitted before the grid navigates to a new page or applies a new page size.

    Cancellable — calling preventDefault() (or returning a falsy result from addEventListener synchronously) aborts the page change.

    quickFilterChanged: CustomEvent<ApexQuickFilterChangedEvent>

    Emitted after a quick-filter change has been applied and the pipeline has run.

    quickFilterChanging: CustomEvent<ApexQuickFilterChangingEvent>

    Emitted before the quick-filter value is applied.

    Cancellable — calling preventDefault() aborts the change. The value can be replaced inside the listener by reassigning ApexGrid.quickFilter.

    rowEditEnded: CustomEvent<ApexRowEditEndedEvent>

    Emitted when a row leaves edit mode, with committed reporting whether pending edits were applied (row edit mode only).

    rowEditStarted: CustomEvent<ApexRowEditStartedEvent>

    Emitted when a row enters edit mode (row edit mode only).

    rowExpanded: CustomEvent<ApexRowExpandedEvent<T>>

    Emitted after a row-expansion change has been applied.

    rowExpanding: CustomEvent<ApexRowExpandingEvent<T>>

    Emitted before the row expansion set changes.

    Cancellable — calling preventDefault() aborts the change. Fires for every expansion-mutating call (toggle, expand-all, programmatic expandedRows = ...).

    rowSelected: CustomEvent<ApexRowSelectedEvent<T>>

    Emitted after a row-selection change has been applied.

    rowSelecting: CustomEvent<ApexRowSelectingEvent<T>>

    Emitted before the row selection set changes.

    Cancellable — calling preventDefault() aborts the selection change. Fires for every selection-mutating call (toggle, range select, select-all, programmatic selectedRows = ...).

    sorted: CustomEvent<SortExpression<T, keyof T>>

    Emitted when a sort operation initiated through the UI has completed. Returns the sort expression used for the operation.

    sorting: CustomEvent<SortExpression<T, keyof T>>

    Emitted when sorting is initiated through the UI. Returns the sort expression which will be used for the operation.

    The event is cancellable which prevents the operation from being applied. The expression can be modified prior to the operation running.

    treeRowExpanded: CustomEvent<ApexTreeRowExpandedEvent<T>>

    Emitted after a tree-row expansion change has been applied.

    treeRowExpanding: CustomEvent<ApexTreeRowExpandingEvent<T>>

    Emitted before the tree-row expansion set changes.

    Fires only when ApexGrid.tree is enabled and a row's tree expansion is toggled (via the chevron, the public API, or expand-all/collapse-all). Cancellable.

    Settings

    Member Visibility

    On This Page

    Events