Edit

Share via

Excel.Interfaces.SlicerLoadOptions interface

  • Reference
Package:
excel

Represents a Slicer object in the workbook.

Remarks

[ API set: ExcelApi 1.10 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
caption

Represents the caption of the slicer.
height

Represents 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.
sortBy

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

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

caption

Represents the caption of the slicer.

caption?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

height

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

Represents the unique ID of the slicer.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

isFilterCleared

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

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

Represents the name of the slicer.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

sortBy

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

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

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

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

Represents the worksheet containing the slicer.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.10 ]