Interface PivotGroup

One group of a PivotAxis. The axis answers the same object for a group every time, so a group can key a map.

interface PivotGroup {
    getChildren(): readonly PivotGroup[];
    getFirstRecord(): number;
    getKeys(): readonly Scalar[];
    getLevel(): number;
    getParent(): PivotGroup | null;
    getSize(): number;
}

Index

Methods

getChildren getFirstRecord getKeys getLevel getParent getSize

Methods

getChildren

getChildren(): readonly PivotGroup[]

The groups one level down, in the order their first records appear.

Returns readonly PivotGroup[]

getFirstRecord

getFirstRecord(): number

The row of the group's first record within the keys.

Returns number

getKeys

getKeys(): readonly Scalar[]

The keys, one per level down to this group's own. Each level's key is spelled by the first record of the group at that level, so a group's keys begin with its parent's. A blank key is null.

Returns readonly Scalar[]

getLevel

getLevel(): number

The number of key columns the group is keyed by: 0 for the root, 1 for the groups of the first key column, and so on.

Returns number

getParent

getParent(): PivotGroup | null

The group one level up, or null for the root.

Returns PivotGroup | null

getSize

getSize(): number

The number of kept records in the group.

Returns number