Excel.PivotTableStyleCollection class

Package:

excel

Represents a collection of PivotTable styles.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.10 ]

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, makeUniqueName)	Creates a blank PivotTableStyle with the specified name.
getCount()	Gets the number of PivotTable styles in the collection.
getDefault()	Gets the default PivotTable style for the parent object's scope.
getItem(name)	Gets a PivotTableStyle by name.
getItemOrNullObject(name)	Gets a PivotTableStyle by name. If the PivotTableStyle 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.
setDefault(newDefaultStyle)	Sets the default PivotTable style for use in the parent object's scope.
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's passed to it.) Whereas the original Excel.PivotTableStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableStyleCollectionData) 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.

TypeScript

context: RequestContext;

Property Value

Excel.RequestContext

items

Gets the loaded child items in this collection.

TypeScript

readonly items: Excel.PivotTableStyle[];

Property Value

Excel.PivotTableStyle[]

Method Details

add(name, makeUniqueName)

Creates a blank PivotTableStyle with the specified name.

TypeScript

add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle;

Parameters

name

string

The unique name for the new PivotTable style. Will throw an InvalidArgument error if the name is already in use.

makeUniqueName

boolean

Optional. Defaults to false. If true, will append numbers to the name in order to make it unique, if needed.

Returns

Excel.PivotTableStyle

The newly created PivotTableStyle.

Remarks

[ API set: ExcelApi 1.10 ]

getCount()

Gets the number of PivotTable styles in the collection.

TypeScript

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[ API set: ExcelApi 1.10 ]

getDefault()

Gets the default PivotTable style for the parent object's scope.

TypeScript

getDefault(): Excel.PivotTableStyle;

Returns

Excel.PivotTableStyle

The PivotTableStyle object that is the current default PivotTable style.

Remarks

[ API set: ExcelApi 1.10 ]

getItem(name)

Gets a PivotTableStyle by name.

TypeScript

getItem(name: string): Excel.PivotTableStyle;

Parameters

name

string

Name of the PivotTable style to be retrieved.

Returns

Excel.PivotTableStyle

The PivotTableStyle object whose name matches the input.

Remarks

[ API set: ExcelApi 1.10 ]

getItemOrNullObject(name)

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

TypeScript

getItemOrNullObject(name: string): Excel.PivotTableStyle;

Parameters

name

string

Name of the PivotTable style to be retrieved.

Returns

Excel.PivotTableStyle

The PivotTableStyle object whose name matches the input.

Remarks

[ API set: ExcelApi 1.10 ]

load(options)

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

TypeScript

load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection;

Parameters

options

Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.PivotTableStyleCollection

load(propertyNames)

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

TypeScript

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.PivotTableStyleCollection

load(propertyNamesAndPaths)

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

TypeScript

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

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.PivotTableStyleCollection

setDefault(newDefaultStyle)

Sets the default PivotTable style for use in the parent object's scope.

TypeScript

setDefault(newDefaultStyle: PivotTableStyle | string): void;

Parameters

newDefaultStyle

Excel.PivotTableStyle | string

The PivotTableStyle object, or name of the PivotTableStyle object, that should be the new default.

Returns

void

Remarks

[ API set: ExcelApi 1.10 ]

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

TypeScript

toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;

Returns

Excel.Interfaces.PivotTableStyleCollectionData