Interface ApexGridEventMap<T>

Events for the apex-grid.

interface ApexGridEventMap<T extends object> {
    filtered: CustomEvent<ApexFilteredEvent<T>>;
    filtering: CustomEvent<ApexFilteringEvent<T>>;
    sorted: CustomEvent<SortExpression<T, keyof T>>;
    sorting: CustomEvent<SortExpression<T, keyof T>>;
}

Events

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.

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.