Excel.Interfaces.DataBarConditionalFormatLoadOptions interface

Package:

excel

Represents an Excel conditional data bar type.

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).
axisColor	HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.
axisFormat	Representation of how the axis is determined for an Excel data bar.
barDirection	Specifies the direction that the data bar graphic should be based on.
lowerBoundRule	The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The ConditionalDataBarRule object must be set as a JSON object (use x.lowerBoundRule = {...} instead of x.lowerBoundRule.formula = ...).
negativeFormat	Representation of all values to the left of the axis in an Excel data bar.
positiveFormat	Representation of all values to the right of the axis in an Excel data bar.
showDataBarOnly	If true, hides the values from the cells where the data bar is applied.
upperBoundRule	The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The ConditionalDataBarRule object must be set as a JSON object (use x.upperBoundRule = {...} instead of x.upperBoundRule.formula = ...).

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

axisColor

HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.

axisColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

axisFormat

Representation of how the axis is determined for an Excel data bar.

axisFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

barDirection

Specifies the direction that the data bar graphic should be based on.

barDirection?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

lowerBoundRule

The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The ConditionalDataBarRule object must be set as a JSON object (use x.lowerBoundRule = {...} instead of x.lowerBoundRule.formula = ...).

lowerBoundRule?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

negativeFormat

Representation of all values to the left of the axis in an Excel data bar.

negativeFormat?: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions;

Property Value

Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

positiveFormat

Representation of all values to the right of the axis in an Excel data bar.

positiveFormat?: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions;

Property Value

Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

showDataBarOnly

If true, hides the values from the cells where the data bar is applied.

showDataBarOnly?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

upperBoundRule

The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The ConditionalDataBarRule object must be set as a JSON object (use x.upperBoundRule = {...} instead of x.upperBoundRule.formula = ...).

upperBoundRule?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]