IFClite TypeScript API
    Preparing search index...

    Interface ListGroup

    One group in a grouped list result. With multi-criteria grouping (issue #1790) groups are emitted as a FLAT pre-order list: each parent group is immediately followed by its subgroups (level gives the nesting depth).

    interface ListGroup {
        count: number;
        key: string;
        label: string;
        level?: number;
        path?: string[];
        sums: Record<string, number>;
    }
    Index
    count key label level? path? sums
    count: number

    Number of rows in the group (the Count aggregate, issue #1790).

    key: string

    Opaque unique group key - the JSON encoding of path (see groupPathKey), collision-free even when a model-derived label contains separator-like characters.

    label: string

    Display label for the group header (this level's value only).

    level?: number

    0-based nesting depth (0 = outermost grouping column). Always emitted by summariseListRows; optional for backward type compatibility.

    path?: string[]

    Group-by labels from the outermost level down to this group.

    sums: Record<string, number>

    columnId → summed numeric value, for the configured sum columns.

    Settings
    Member Visibility

    On This Page
    Properties