Excel.Interfaces.SlicerCollectionLoadOptions interface

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 a collection of all the slicer objects on the workbook or a worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

$all
caption

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

height

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

id

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

isFilterCleared

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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 invalid argument exception when set with negative value as input.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

name

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

nameInFormula

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

[ 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 BETA (PREVIEW ONLY) ]

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 BETA (PREVIEW ONLY) ]

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 invalid argument exception when set with negative value as input.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

width

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheet

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Property Details

$all

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.

$all?: boolean;

Property Value

boolean

caption

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 caption of slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

caption?: boolean;

Property Value

boolean

height

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 height, in points, of the slicer. Throws an invalid argument exception when set with negative value or zero as input.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

height?: boolean;

Property Value

boolean

id

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 unique id of slicer. Read-only.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

id?: boolean;

Property Value

boolean

isFilterCleared

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: True if all filters currently applied on the slicer are cleared.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

isFilterCleared?: boolean;

Property Value

boolean

left

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 distance, in points, from the left side of the slicer to the left of the worksheet. Throws an invalid argument exception when set with negative value as input.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

left?: boolean;

Property Value

boolean

name

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 name of slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

sortBy

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 sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

sortBy?: boolean;

Property Value

boolean

style

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: 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 BETA (PREVIEW ONLY) ]

style?: boolean;

Property Value

boolean

top

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 distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an invalid argument exception when set with negative value as input.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

top?: boolean;

Property Value

boolean

width

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 width, in points, of the slicer. Throws an invalid argument exception when set with negative value or zero as input.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

width?: boolean;

Property Value

boolean

worksheet

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value