Excel.SlicerItemCollection class

Represents a collection of all the slicer item objects on the slicer.

[ API set: ExcelApi 1.10 ]

Extends
OfficeExtension.ClientObject

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()

Returns the number of slicer items in the slicer.

[ API set: ExcelApi 1.10 ]

getItem(key)

Gets a slicer item object using its key or name.

[ API set: ExcelApi 1.10 ]

getItemAt(index)

Gets a slicer item based on its position in the collection.

[ API set: ExcelApi 1.10 ]

getItemOrNullObject(key)

Gets a slicer item using its key or name. If the slicer item does not exist, will return a null object.

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

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.SlicerItemCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SlicerItemCollectionData) 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

items

Gets the loaded child items in this collection.

readonly items: Excel.SlicerItem[];

Property Value

Method Details

getCount()

Returns the number of slicer items in the slicer.

[ API set: ExcelApi 1.10 ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

getItem(key)

Gets a slicer item object using its key or name.

[ API set: ExcelApi 1.10 ]

getItem(key: string): Excel.SlicerItem;

Parameters

key
string

The key or name of the slicer item.

Returns

getItemAt(index)

Gets a slicer item based on its position in the collection.

[ API set: ExcelApi 1.10 ]

getItemAt(index: number): Excel.SlicerItem;

Parameters

index
number

Index value of the object to be retrieved. Zero-indexed.

Returns

getItemOrNullObject(key)

Gets a slicer item using its key or name. If the slicer item does not exist, will return a null object.

[ API set: ExcelApi 1.10 ]

getItemOrNullObject(key: string): Excel.SlicerItem;

Parameters

key
string

Key or name of the slicer to be retrieved.

Returns

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.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection;

Parameters

options
Excel.Interfaces.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

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.SlicerItemCollection;

Parameters

propertyNames
string | string[]

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

Returns

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.SlicerItemCollection;

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

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

toJSON(): Excel.Interfaces.SlicerItemCollectionData;

Returns