@helix-x/datagrid-ui - v0.2.0
    Preparing search index...

    Interface UseServerDataSourceOptions<T>

    Options for useServerDataSource.

    interface UseServerDataSourceOptions<T> {
        dataSource: HxDataSource<T>;
        filterModel: FilterModelMap;
        maxCachedBlocks?: number;
        onError?: (error: unknown) => void;
        page: number;
        pageSize: number;
        rowGroupCols?: HxColumnVO[];
        sortModel: SortModelItem[];
        valueCols?: HxColumnVO[];
    }

    Type Parameters

    • T

      The row type.

    Index
    dataSource filterModel maxCachedBlocks? onError? page pageSize rowGroupCols? sortModel valueCols?
    dataSource: HxDataSource<T>

    Where rows come from. Memoise it, or every render refetches.

    filterModel: FilterModelMap

    Active filters, keyed by column id.

    maxCachedBlocks?: number

    Blocks to keep around so paging back and forth does not refetch.

    3
    onError?: (error: unknown) => void

    Called when a fetch throws. Aborted requests are not reported.

    page

    page: number

    Zero-based page index.

    pageSize: number

    Rows per page.

    rowGroupCols?: HxColumnVO[]

    The grouping column, sent as HxRowsRequest.rowGroupCols. When it holds an entry the rows fetched are group rows and totalRows counts groups.

    []
    sortModel: SortModelItem[]

    Active sorts, primary first.

    valueCols?: HxColumnVO[]

    Aggregates wanted on group rows, sent as HxRowsRequest.valueCols.

    []

    Settings
    Member Visibility

    On This Page
    Properties