Excel.PivotTableScopedCollection class

Package:

excel

Represents a scoped collection of PivotTables. The PivotTables are sorted based on the location of the PivotTable's top-left corner. They are ordered top-to-bottom and then left-to-right.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.12 ]

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

getCount()	Gets the number of PivotTables in the collection.
getFirst()	Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that top-left table is the first PivotTable in the collection.
getFirstOrNullObject()	Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection. If the collection is empty, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItem(key)	Gets a PivotTable by name.
getItemOrNullObject(name)	Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
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.PivotTableScopedCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableScopedCollectionData) 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

Excel.RequestContext

items

Gets the loaded child items in this collection.

readonly items: Excel.PivotTable[];

Property Value

Excel.PivotTable[]

Method Details

getCount()

Gets the number of PivotTables in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[ API set: ExcelApi 1.12 ]

getFirst()

Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that top-left table is the first PivotTable in the collection.

getFirst(): Excel.PivotTable;

Returns

Excel.PivotTable

Remarks

[ API set: ExcelApi 1.12 ]

getFirstOrNullObject()

Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection. If the collection is empty, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getFirstOrNullObject(): Excel.PivotTable;

Returns

Excel.PivotTable

Remarks

[ API set: ExcelApi 1.15 ]

getItem(key)

Gets a PivotTable by name.

getItem(key: string): Excel.PivotTable;

Parameters

key

string

Name of the PivotTable to be retrieved.

Returns

Excel.PivotTable

Remarks

[ API set: ExcelApi 1.12 ]

getItemOrNullObject(name)

Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getItemOrNullObject(name: string): Excel.PivotTable;

Parameters

name

string

Name of the PivotTable to be retrieved.

Returns

Excel.PivotTable

Remarks

[ API set: ExcelApi 1.12 ]

load(options)

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

load(options?: Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection;

Parameters

options

Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.PivotTableScopedCollection

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.PivotTableScopedCollection;

Parameters

propertyNames

string | string[]

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

Returns

Excel.PivotTableScopedCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableScopedCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.PivotTableScopedCollection

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.PivotTableScopedCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableScopedCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;

Returns

Excel.Interfaces.PivotTableScopedCollectionData