Skip to content

Latest commit

 

History

History
184 lines (93 loc) · 3.01 KB

Group.md

File metadata and controls

184 lines (93 loc) · 3.01 KB

@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

NonDataRow.constructor

Properties

__group

readonly __group: true = true

Defined in

core/group.ts:7


__nonDataRow

__nonDataRow: boolean = true

Inherited from

NonDataRow.__nonDataRow

Defined in

core/base.ts:5


collapsed

collapsed: boolean = false

Whether a group is collapsed.

Defined in

core/group.ts:42


count

count: number = 0

Number of rows in the group.

Defined in

core/group.ts:21


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

core/group.ts:71


groups

groups: Group<TEntity>[]

Sub-groups that are part of the group.

Defined in

core/group.ts:63


level

level: number = 0

Grouping level, starting with 0.

Defined in

core/group.ts:14


rows

rows: TEntity[] = []

Rows that are part of the group.

Defined in

core/group.ts:56


title

title: string

Formatted display value of the group.

Defined in

core/group.ts:35


totals

totals: GroupTotals<TEntity>

GroupTotals, if any.

Defined in

core/group.ts:49


value

value: any

Grouping value.

Defined in

core/group.ts:28

Methods

equals()

equals(group): boolean

Compares two Group instances.

Parameters

group

Group<any>

{Group} Group instance to compare to.

Returns

boolean

Defined in

core/group.ts:79