Class RowGroup<T>

A group of a row grouping (see RowGroupIf). Created by groupRows and AreaModelRowGroups – you don't create groups yourself.

Example

const groups = groupRows(sales, ["region"]);
aggregateRowGroups(groups, { umsatz: "sum" });
groups.map(g => `${g.label}: ${g.results.umsatz}`);   // ["Nord: 270", "Süd: 180"]

Since

1.1.94

Type Parameters

  • T = any

    the row type

Hierarchy

  • RowGroup

Implements

Constructors

constructor

Properties

children count field key label level parent path results type

Accessors

id

Methods

getRows isLeaf

Constructors

constructor

Properties

Readonly children

children: RowGroup<T>[] = []

The sub-groups, empty on the last level.

count

count: number = 0

The number of rows in the group (after the filter).

Readonly field

field: string

The name of the level (RowGroupFieldIf.name).

Readonly key

key: unknown

The key of the group, as the rows have it (null for the group of empty keys: null, undefined, "").

Readonly label

label: string

The key as text (format of the level, otherwise the default text).

Readonly level

level: number

The level, 0 = top.

Readonly parent

parent: undefined | RowGroup<T>

The parent group, undefined on the top level.

Readonly path

path: readonly unknown[]

The keys from the top level down to this group.

results

results: Record<string, unknown> = {}

The aggregates of the group by key (after the filter), e.g. { umsatz: 270 }.

Readonly type

type: "RowGroup" = "RowGroup"

Marker for isRowGroup.

Accessors

id

Methods

getRows

  • The rows of the group and of all sub-groups, in the order of the grouped view: sub-group by sub-group, the rows of a group in source order – or sorted, after the table sorted them.

    Parameters

    • filtered: boolean = true

      only the rows the filter keeps

    Returns T[]

    a new array

isLeaf

Settings

Member Visibility

Theme

On This Page