Interface PivotView

A pivot table as the values it shows — see IFormulaContext.getPivotAt.

interface PivotView {
    getDataFields(): readonly PivotViewDataField[];
    getFields(): readonly PivotViewField[];
    getValue(
        dataField: number,
        items: ReadonlyMap<number, number>,
    ): Scalar | undefined;
    isComputed?(): boolean;
}

Index

Methods

getDataFields getFields getValue isComputed?

Methods

getDataFields

getDataFields(): readonly PivotViewDataField[]

The table's values, in its order.

Returns readonly PivotViewDataField[]

getFields

getFields(): readonly PivotViewField[]

The fields on the table's rows, columns and pages, in that order.

Returns readonly PivotViewField[]

getValue

getValue(
dataField: number,
items: ReadonlyMap<number, number>,
): Scalar | undefined
A value the table shows.
Parameters
- dataField: number
  The value, by index into getDataFields.
- items: ReadonlyMap<number, number>
  Per field, by index into getFields, the item by index into its PivotViewField.items. A field left out is totaled over.
Returns Scalar | undefined
The value, or undefined when the table does not show it: a line it does not show (a hidden or collapsed item, a subtotal or grand total turned off), an item not on its page, or a crossing with no records.

`Optional`isComputed

isComputed?(): boolean

Whether the table's values are known here.

Returns boolean
false for a table that is there but whose values the host does not compute: its fields and values are empty, and a caller that answered from it before keeps that answer, as the table only changes on a refresh. Absent means true.