@serenity-is/sleekgrid / Group
Class: Group<TEntity>
Information about a group of rows.
Extends
Type Parameters
• TEntity = any
Constructors
new Group()
new Group<
TEntity>():Group<TEntity>
Returns
Group<TEntity>
Inherited from
Properties
__group
readonly__group:true=true
Defined in
__nonDataRow
__nonDataRow:
boolean=true
Inherited from
Defined in
collapsed
collapsed:
boolean=false
Whether a group is collapsed.
Defined in
count
count:
number=0
Number of rows in the group.
Defined in
groupingKey
groupingKey:
string
A unique key used to identify the group. This key can be used in calls to DataView collapseGroup() or expandGroup().
Defined in
groups
groups:
Group<TEntity>[]
Sub-groups that are part of the group.
Defined in
level
level:
number=0
Grouping level, starting with 0.
Defined in
rows
rows:
TEntity[] =[]
Rows that are part of the group.
Defined in
title
title:
string
Formatted display value of the group.
Defined in
totals
totals:
GroupTotals<TEntity>
GroupTotals, if any.
Defined in
value
value:
any
Grouping value.
Defined in
Methods
equals()
equals(
group):boolean
Compares two Group instances.
Parameters
group
Group<any>
Group instance to compare to.
Returns
boolean