PivotColumnGroupContext

Read-only metadata supplied to group-header customization.

Props

The following table outlines the props for the PivotColumnGroupContext:

NameTypeDefaultDescription
column
-

Generated group definition before customization.

field
string
-

Dimension field; absent for grand totals.

level
number
-

Zero-based group depth.

path
ReadonlyArray<Readonly<PivotAxisPath[number]>>
-

Typed member path.

sourceColumn
Readonly<ColumnProps<T>>
-

Source dimension definition; absent for grand totals.

totalKind
-

Group category.

value
PivotAxisPath[number]['value']
-

Typed member value; absent for grand totals.