Excel.Interfaces.SlicerCollectionLoadOptions interface

Package:

excel

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

Remarks

[ 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 the slicer.
height	For EACH ITEM in the collection: Represents the height, in points, of the slicer. Throws an InvalidArgument exception when set with a negative value or zero as an input.
id	For EACH ITEM in the collection: Represents the unique ID of the slicer.
isFilterCleared	For EACH ITEM in the collection: Value is true if all filters currently applied on the slicer are cleared.
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 InvalidArgument error when set with a negative value as an input.
name	For EACH ITEM in the collection: Represents the name of the slicer.
nameInFormula	For EACH ITEM in the collection: Represents the slicer name used in the formula.
slicerStyle	For EACH ITEM in the collection: The style applied to the slicer.
sortBy	For EACH ITEM in the collection: Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".
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.
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 InvalidArgument error when set with a negative value as an input.
width	For EACH ITEM in the collection: Represents the width, in points, of the slicer. Throws an InvalidArgument error when set with a negative value or zero as an input.
worksheet	For EACH ITEM in the collection: Represents the worksheet containing the slicer.

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 the slicer.

caption?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

height

For EACH ITEM in the collection: Represents the height, in points, of the slicer. Throws an InvalidArgument exception when set with a negative value or zero as an input.

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

id

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

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

isFilterCleared

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

isFilterCleared?: boolean;

Property Value

boolean

Remarks

[ 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 InvalidArgument error when set with a negative value as an input.

left?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

name

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

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

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.

nameInFormula?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

slicerStyle?: Excel.Interfaces.SlicerStyleLoadOptions;

Property Value

Excel.Interfaces.SlicerStyleLoadOptions

Remarks

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

sortBy?: boolean;

Property Value

boolean

Remarks

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

style?: boolean;

Property Value

boolean

Remarks

[ 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 InvalidArgument error when set with a negative value as an input.

top?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

width

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

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

worksheet

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

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.10 ]