Excel.Interfaces.SlicerCollectionLoadOptions interface

Represents a collection of all the slicer objects on the workbook or a worksheet.

[ API set: ExcelApi 1.10 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

caption

For EACH ITEM in the collection: Represents the caption of slicer.

[ API set: ExcelApi 1.10 ]

height

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Represents the unique id of slicer.

[ API set: ExcelApi 1.10 ]

isFilterCleared

For EACH ITEM in the collection: True if all filters currently applied on the slicer are cleared.

[ API set: ExcelApi 1.10 ]

left

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Represents the name of slicer.

[ API set: ExcelApi 1.10 ]

nameInFormula

For EACH ITEM in the collection: Represents the slicer name used in the formula.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

slicerStyle

For EACH ITEM in the collection: The style applied to the Slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

sortBy

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

[ API set: ExcelApi 1.10 ]

style

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Represents the worksheet containing the slicer.

[ API set: ExcelApi 1.10 ]

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

caption

For EACH ITEM in the collection: Represents the caption of slicer.

[ API set: ExcelApi 1.10 ]

caption?: boolean;

Property Value

boolean

height

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

id

For EACH ITEM in the collection: Represents the unique id of slicer.

[ API set: ExcelApi 1.10 ]

id?: boolean;

Property Value

boolean

isFilterCleared

For EACH ITEM in the collection: True if all filters currently applied on the slicer are cleared.

[ API set: ExcelApi 1.10 ]

isFilterCleared?: boolean;

Property Value

boolean

left

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

name

For EACH ITEM in the collection: Represents the name of slicer.

[ API set: ExcelApi 1.10 ]

name?: boolean;

Property Value

boolean

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.

For EACH ITEM in the collection: Represents the slicer name used in the formula.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

nameInFormula?: boolean;

Property Value

boolean

slicerStyle

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.

For EACH ITEM in the collection: The style applied to the Slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

slicerStyle?: Excel.Interfaces.SlicerStyleLoadOptions;

Property Value

sortBy

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

[ API set: ExcelApi 1.10 ]

sortBy?: boolean;

Property Value

boolean

style

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

top

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

width

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

worksheet

For EACH ITEM in the collection: Represents the worksheet containing the slicer.

[ API set: ExcelApi 1.10 ]

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value