Interface PivotColumnInfoIf

What a value column of a pivot table shows (AreaModelPivot.getColumnInfo): the values of one column key ("value"), the subtotal of a column group ("subtotal", with PivotConfigIf.columnSubtotals) or the total over all column keys ("total").

Example

const info = pivotModel.getPivotBody().getColumnInfo(columnIndex);
if (info?.kind === "value") console.log(info.column?.path, info.value.name);   // ["Jan"], "sum(umsatz)"

Since

1.1.94

Hierarchy

  • PivotColumnInfoIf

Properties

column? kind value valueIndex

Properties

Optional Readonly column

column?: RowGroupIf<any>

The column key (lowest level) or column group; undefined for the total.

Readonly kind

kind: "total" | "value" | "subtotal"

"value" – one column key, "subtotal" – a column group, "total" – all columns.

Readonly value

value: PivotValueInfoIf

The value shown in the column.

Readonly valueIndex

valueIndex: number

The index of the value in PivotConfigIf.values.

Settings

Member Visibility

Theme

On This Page