@serenity-is/sleekgrid / Group
Class: Group<TEntity>
Defined in: src/core/group.ts:7
Information about a group of rows.
Extends
Type Parameters
TEntity
TEntity = any
Constructors
Constructor
new Group<
TEntity>():Group<TEntity>
Returns
Group<TEntity>
Inherited from
Properties
__group
readonly__group:true=true
Defined in: src/core/group.ts:8
__nonDataRow
__nonDataRow:
boolean=true
Defined in: src/core/base.ts:5
Inherited from
collapsed
collapsed:
boolean=false
Defined in: src/core/group.ts:36
Whether a group is collapsed.
count
count:
number=0
Defined in: src/core/group.ts:22
Number of rows in the group.
formatValue()
formatValue: (
ctx) =>FormatterResult
Defined in: src/core/group.ts:68
Returns a text representation of the group value.
Parameters
ctx
FormatterContext<Group<TEntity>>
Returns
groupingKey
groupingKey:
string
Defined in: src/core/group.ts:65
A unique key used to identify the group. This key can be used in calls to DataView collapseGroup() or expandGroup().
groups
groups:
Group<TEntity>[]
Defined in: src/core/group.ts:57
Sub-groups that are part of the group.
level
level:
number=0
Defined in: src/core/group.ts:15
Grouping level, starting with 0.
rows
rows:
TEntity[] =[]
Defined in: src/core/group.ts:50
Rows that are part of the group.
totals
totals:
GroupTotals<TEntity>
Defined in: src/core/group.ts:43
GroupTotals, if any.
value
value:
any
Defined in: src/core/group.ts:29
Grouping value.
Methods
equals()
equals(
group):boolean
Defined in: src/core/group.ts:75
Compares two Group instances.
Parameters
group
Group
Group instance to compare to.
Returns
boolean