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

    Interface UseRowGroupingOptions<T>

    Options for useRowGrouping.

    interface UseRowGroupingOptions<T> {
        blockSize?: number;
        dataSource: HxDataSource<T>;
        filterModel: FilterModelMap;
        getGroupChildCount?: (row: T) => number | null | undefined;
        groupColumn: ColumnDef<T, never> | null;
        onError?: (error: unknown) => void;
        rowGroupCols: HxColumnVO[];
        rows: T[];
        sortModel: SortModelItem[];
        valueCols: HxColumnVO[];
    }

    Type Parameters

    • T

      The row type.

    Index
    blockSize? dataSource filterModel getGroupChildCount? groupColumn onError? rowGroupCols rows sortModel valueCols
    blockSize?: number

    Rows asked for each time a group is opened or "Load more" is used.

    100
    dataSource: HxDataSource<T>

    The same data source the grid pages through.

    filterModel: FilterModelMap

    Active filters, sent with every request for a group's rows.

    getGroupChildCount?: (row: T) => number | null | undefined

    Reads a group row's child count.

    the row's numeric childCount field

    groupColumn: ColumnDef<T, never> | null

    The column being grouped by, or null when not grouped. Its value on a group row, as a string, is the group's key.

    onError?: (error: unknown) => void

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

    rowGroupCols: HxColumnVO[]

    Sent with every request for a group's rows.

    rows: T[]

    The page the grid loaded: group rows while grouped, ordinary rows otherwise.

    sortModel: SortModelItem[]

    Active sorts, sent with every request for a group's rows.

    valueCols: HxColumnVO[]

    Sent with every request for a group's rows.

    Settings
    Member Visibility

    On This Page
    Properties