Excel.Interfaces.SlicerData interface

An interface describing the data returned by calling slicer.toJSON().

Properties

caption

Represents the caption of slicer.

[ API set: ExcelApi 1.10 ]

height

Represents the height, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input.

[ API set: ExcelApi 1.10 ]

id

Represents the unique id of slicer. Read-only.

[ API set: ExcelApi 1.10 ]

isFilterCleared

True if all filters currently applied on the slicer are cleared.

[ 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 "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input.

[ API set: ExcelApi 1.10 ]

name

Represents the name of slicer.

[ API set: ExcelApi 1.10 ]

nameInFormula

Represents the slicer name used in the formula.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

slicerItems

Represents the collection of SlicerItems that are part of the slicer. Read-only.

[ API set: ExcelApi 1.10 ]

sortBy

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

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

[ 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 "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input.

[ API set: ExcelApi 1.10 ]

width

Represents the width, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input.

[ API set: ExcelApi 1.10 ]

worksheet

Represents the worksheet containing the slicer. Read-only.

[ API set: ExcelApi 1.10 ]

Property Details

caption

Represents the caption of slicer.

[ API set: ExcelApi 1.10 ]

caption?: string;

Property Value

string

height

Represents the height, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input.

[ API set: ExcelApi 1.10 ]

height?: number;

Property Value

number

id

Represents the unique id of slicer. Read-only.

[ API set: ExcelApi 1.10 ]

id?: string;

Property Value

string

isFilterCleared

True if all filters currently applied on the slicer are cleared.

[ API set: ExcelApi 1.10 ]

isFilterCleared?: boolean;

Property Value

boolean

left

Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input.

[ API set: ExcelApi 1.10 ]

left?: number;

Property Value

number

name

Represents the name of slicer.

[ API set: ExcelApi 1.10 ]

name?: string;

Property Value

string

nameInFormula

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the slicer name used in the formula.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

nameInFormula?: string;

Property Value

string

slicerItems

Represents the collection of SlicerItems that are part of the slicer. Read-only.

[ API set: ExcelApi 1.10 ]

slicerItems?: Excel.Interfaces.SlicerItemData[];

Property Value

sortBy

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

[ API set: ExcelApi 1.10 ]

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

Property Value

Excel.SlicerSortType | "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.

[ API set: ExcelApi 1.10 ]

style?: string;

Property Value

string

top

Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input.

[ API set: ExcelApi 1.10 ]

top?: number;

Property Value

number

width

Represents the width, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input.

[ API set: ExcelApi 1.10 ]

width?: number;

Property Value

number

worksheet

Represents the worksheet containing the slicer. Read-only.

[ API set: ExcelApi 1.10 ]

worksheet?: Excel.Interfaces.WorksheetData;

Property Value