apex-grid
    Preparing search index...

    Interface DataPipelineConfiguration<T>

    Configuration for customizing the various data operations of the grid.

    interface DataPipelineConfiguration<T extends object> {
        filter?: DataPipelineHook<T>;
        pagination?: DataPipelineHook<T>;
        quickFilter?: DataPipelineHook<T>;
        sort?: DataPipelineHook<T>;
    }

    Type Parameters

    • T extends object
    Index

    Properties

    filter? pagination? quickFilter? sort?

    Properties

    filter?: DataPipelineHook<T>

    Hook for customizing filter operations.

    pagination?: DataPipelineHook<T>

    Hook for customizing pagination operations.

    The hook receives the filtered + sorted data slice for the grid to render and the current pagination state. Return the page slice. For server-driven pagination, return the externally fetched page and report the row total via ApexGrid.totalItems.

    quickFilter?: DataPipelineHook<T>

    Hook for customizing quick (global) filter operations.

    Called before column filtering. Return the records that match the ApexGrid.quickFilter value. If omitted, the default substring matcher is used.

    sort?: DataPipelineHook<T>

    Hook for customizing sort operations.

    Settings

    Member Visibility

    On This Page

    Properties