Provides the details for an updated event from a pivot table subscription. Unlike TableData, this class offers a matrix of data for each value column, and row/column expand state, depth, and grand totals.

Hierarchy

  • PivotSnapshot

Constructors

Accessors

Methods

Constructors

Accessors

  • get columns(): DimensionData
  • Data specific to the column dimension of the pivot table, including the groups, depth of each column, whether each column is expanded, and the totals for each column.

    Returns DimensionData

  • get rows(): DimensionData
  • Data specific to the row dimension of the pivot table, including the groups, depth of each row, whether each row is expanded, and the totals for each row.

    Returns DimensionData

  • get valueSources(): PivotSource[]
  • The value sources that were included in the subscription and can be read from this snapshot.

    Returns PivotSource[]

Methods

  • Returns the grand total for a given value source in the pivot table.

    The type of this data will match the type of the provided PivotSource.

    Parameters

    • value: PivotSource

      the value source to read, must have been included in the subscription

    Returns any

    the grand total for the given value source

  • Reads a value from the pivot table data for a given position in the grid.

    The type of this data will match the type of the provided PivotSource.

    Parameters

    • value: PivotSource

      the value source to read, must have been included in the subscription

    • rowPosition: number

      the row position within the pivot table

    • colPosition: number

      the column position within the pivot table

    Returns any

    the value present in the pivot table at the given position