Excel.PivotTableCollection class

Represents a collection of all the PivotTables that are part of the workbook or worksheet.

[ API set: ExcelApi 1.3 ]

Extends

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

items

Gets the loaded child items in this collection.

Methods

add(name, source, destination)

Add a Pivottable based on the specified source data and insert it at the top left cell of the destination range.

[ API set: ExcelApi 1.8 ]

getCount()

Gets the number of pivot tables in the collection.

[ API set: ExcelApi 1.4 ]

getItem(name)

Gets a PivotTable by name.

[ API set: ExcelApi 1.3 ]

getItemOrNullObject(name)

Gets a PivotTable by name. If the PivotTable does not exist, will return a null object.

[ API set: ExcelApi 1.4 ]

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

refreshAll()

Refreshes all the pivot tables in the collection.

[ API set: ExcelApi 1.3 ]

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotTableCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

RequestContext

items

Gets the loaded child items in this collection.

readonly items: Excel.PivotTable[];

Property Value

Excel.PivotTable[]

Method Details

add(name, source, destination)

Add a Pivottable based on the specified source data and insert it at the top left cell of the destination range.

[ API set: ExcelApi 1.8 ]

add(name: string, source: Range | string | Table, destination: Range | string): Excel.PivotTable;

Parameters

name
string

The name of the new PivotTable.

source
Range | string | Table

The source data for the new PivotTable, this can either be a range (or string address including the worksheet name) or a table.

destination
Range | string

The cell in the upper-left corner of the PivotTable report's destination range (the range on the worksheet where the resulting report will be placed).

Returns

Returns the newly inserted PivotTable.

Examples

await Excel.run(async (context) => {
    const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
    const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2");
    context.workbook.worksheets.getItem("Pivot").pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot);

    await context.sync();
});

getCount()

Gets the number of pivot tables in the collection.

[ API set: ExcelApi 1.4 ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

getItem(name)

Gets a PivotTable by name.

[ API set: ExcelApi 1.3 ]

getItem(name: string): Excel.PivotTable;

Parameters

name
string

Name of the PivotTable to be retrieved.

Returns

getItemOrNullObject(name)

Gets a PivotTable by name. If the PivotTable does not exist, will return a null object.

[ API set: ExcelApi 1.4 ]

getItemOrNullObject(name: string): Excel.PivotTable;

Parameters

name
string

Name of the PivotTable to be retrieved.

Returns

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.PivotTableCollection;

Parameters

option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.PivotTableCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTableCollection - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

refreshAll()

Refreshes all the pivot tables in the collection.

[ API set: ExcelApi 1.3 ]

refreshAll(): void;

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotTableCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.PivotTableCollectionData;

Returns