Skip to content

@graphty/graphty-element / session / SummaryGroup

Interface: SummaryGroup ​

Defined in: graphty-element/src/session/results/types.ts:776

One group in a summary, for a result that partitions rather than measures.

Properties ​

group ​

readonly group: string | number

Defined in: graphty-element/src/session/results/types.ts:778

The group's identity, as the result publishes it.


name? ​

readonly optional name?: string

Defined in: graphty-element/src/session/results/types.ts:793

What to call it, such as "Group 1", for a result that partitions into groups.

Deprecated ​

English words; word the group from SummaryGroup.rank instead. Removed in the next major.


rank? ​

readonly optional rank?: number

Defined in: graphty-element/src/session/results/types.ts:787

Its place by size, from 1 for the largest, ties ordered by group id, for a result that partitions into groups. The legend of a colour encoding over the same groups carries the same rank on each swatch, and a page column of the group field carries it per cell, so every surface names a group the same way: word it from the rank ("Group 3").


size ​

readonly size: number

Defined in: graphty-element/src/session/results/types.ts:780

How many elements are in it.