Edit

Share via

Excel.Interfaces.IconSetConditionalFormatLoadOptions interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

Represents an icon set criteria for conditional formatting.

Remarks

[ API set: ExcelApi 1.6 ]

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).
criteria

An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set.
reverseIconOrder

If true, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used.
showIconOnly

If true, hides the values and only shows icons.
style

If set, displays the icon set option for the conditional format.

Property Details

$all

Warning

This API is now deprecated.

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

criteria

Warning

This API is now deprecated.

An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set.

criteria?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

reverseIconOrder

Warning

This API is now deprecated.

If true, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used.

reverseIconOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

showIconOnly

Warning

This API is now deprecated.

If true, hides the values and only shows icons.

showIconOnly?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

style

Warning

This API is now deprecated.

If set, displays the icon set option for the conditional format.

style?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]