Excel.Slicer class

Package:

excel

Represents a Slicer object in the workbook.

Extends

OfficeExtension.ClientObject

Remarks

[Api set: ExcelApi 1.10]

Properties

caption	Represents the caption of the slicer.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
height	Specifies the height, in points, of the slicer. Throws an InvalidArgument exception when set with a negative value or zero as an input.
id	Represents the unique ID of the slicer.
isFilterCleared	Value is true if all filters currently applied on the slicer are cleared.
left	Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an InvalidArgument error when set with a negative value as an input.
name	Represents the name of the slicer.
slicerItems	Represents the collection of slicer items that are part of the slicer.
sortBy	Specifies the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".
style	Constant value that represents the slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified.
top	Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an InvalidArgument error when set with a negative value as an input.
width	Represents the width, in points, of the slicer. Throws an InvalidArgument error when set with a negative value or zero as an input.
worksheet	Represents the worksheet containing the slicer.

Methods

clearFilters()	Clears all the filters currently applied on the slicer.
delete()	Deletes the slicer.
getSelectedItems()	Returns an array of selected items' keys.
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.
selectItems(items)	Selects slicer items based on their keys. The previous selections are cleared. All items will be selected by default if the array is empty.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
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.Slicer object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SlicerData) that contains shallow copies of any loaded child properties from the original object.

Property Details

caption

Represents the caption of the slicer.

caption: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.10]

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

height

Specifies the height, in points, of the slicer. Throws an InvalidArgument exception when set with a negative value or zero as an input.

height: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.10]

id

Represents the unique ID of the slicer.

readonly id: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.10]

isFilterCleared

Value is true if all filters currently applied on the slicer are cleared.

readonly isFilterCleared: boolean;

Property Value

boolean

Remarks

[Api set: ExcelApi 1.10]

left

Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an InvalidArgument error when set with a negative value as an input.

left: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.10]

name

Represents the name of the slicer.

name: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.10]

slicerItems

Represents the collection of slicer items that are part of the slicer.

readonly slicerItems: Excel.SlicerItemCollection;

Property Value

Excel.SlicerItemCollection

Remarks

[Api set: ExcelApi 1.10]

sortBy

Specifies the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".

sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";

Property Value

Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

Remarks

[Api set: ExcelApi 1.10]

style

Constant value that represents the slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified.

style: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.10]

top

Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an InvalidArgument error when set with a negative value as an input.

top: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.10]

width

Represents the width, in points, of the slicer. Throws an InvalidArgument error when set with a negative value or zero as an input.

width: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.10]

worksheet

Represents the worksheet containing the slicer.

readonly worksheet: Excel.Worksheet;

Property Value

Excel.Worksheet

Remarks

[Api set: ExcelApi 1.10]

Method Details

clearFilters()

Clears all the filters currently applied on the slicer.

clearFilters(): void;

Returns

void

Remarks

[Api set: ExcelApi 1.10]

delete()

Deletes the slicer.

delete(): void;

Returns

void

Remarks

[Api set: ExcelApi 1.10]

getSelectedItems()

Returns an array of selected items' keys.

getSelectedItems(): OfficeExtension.ClientResult<string[]>;

Returns

OfficeExtension.ClientResult<string[]>

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.

load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;

Parameters

options

Excel.Interfaces.SlicerLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.Slicer

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.Slicer

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?: {
            select?: string;
            expand?: string;
        }): Excel.Slicer;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

selectItems(items)

Selects slicer items based on their keys. The previous selections are cleared. All items will be selected by default if the array is empty.

selectItems(items?: string[]): void;

Parameters

items

string[]

Optional. The specified slicer item names to be selected.

Returns

void

Remarks

[Api set: ExcelApi 1.10]

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Excel.Interfaces.SlicerUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Slicer): void;

Parameters

properties

Excel.Slicer

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

toJSON(): Excel.Interfaces.SlicerData;

Returns

Excel.Interfaces.SlicerData