@serenity-is/corelib / GroupInfo

Interface: GroupInfo<TItem>

Defined in: src/slick/slicktypes.ts:24

Type Parameters

TItem

TItem

Properties

aggregateChildGroups?

optional aggregateChildGroups: boolean

Defined in: src/slick/slicktypes.ts:37

---

aggregateCollapsed?

optional aggregateCollapsed: boolean

Defined in: src/slick/slicktypes.ts:38

---

aggregateEmpty?

optional aggregateEmpty: boolean

Defined in: src/slick/slicktypes.ts:39

---

aggregators?

optional aggregators: IAggregator[]

Defined in: src/slick/slicktypes.ts:36

---

collapsed?

optional collapsed: boolean

Defined in: src/slick/slicktypes.ts:40

---

comparer()?

optional comparer: (a, b) => number

Defined in: src/slick/slicktypes.ts:35

Parameters

a

Group<TItem>

b

Group<TItem>

Returns

number

---

displayTotalsRow?

optional displayTotalsRow: boolean

Defined in: src/slick/slicktypes.ts:41

---

format()?

optional format: (ctx) => FormatterResult

Defined in: src/slick/slicktypes.ts:32

The format function for the group value. Note that the group item is in ctx.item and its value is in ctx.item.value, not in ctx.value as it is set by the grid to ctx.item["groupdisplaycolumnfield"] so never use or rely on ctx.value here!

Parameters

ctx

FormatterContext<Group<TItem>>

Returns

FormatterResult

---

formatter()?

optional formatter: (group) => string

Defined in: src/slick/slicktypes.ts:34

Parameters

group

Group<TItem>

Returns

string

Deprecated

use format

---

getter?

optional getter: string | (item) => any

Defined in: src/slick/slicktypes.ts:25

---

getterIsAFn?

optional getterIsAFn: boolean

Defined in: src/slick/slicktypes.ts:26

---

lazyTotalsCalculation?

optional lazyTotalsCalculation: boolean

Defined in: src/slick/slicktypes.ts:42

---

predefinedValues?

optional predefinedValues: any[]

Defined in: src/slick/slicktypes.ts:43