Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Excel.Interfaces.DataBarConditionalFormatData interface

Package:
excel

An interface describing the data returned by calling dataBarConditionalFormat.toJSON().

Remarks

Used by

Properties

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

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?: string;

Property Value

string

Remarks

API set: ExcelApi 1.6

axisFormat

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

axisFormat?: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";

Property Value

Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"

Remarks

API set: ExcelApi 1.6

barDirection

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

barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";

Property Value

Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"

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?: Excel.ConditionalDataBarRule;

Property Value

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.ConditionalDataBarNegativeFormatData;

Property Value

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.ConditionalDataBarPositiveFormatData;

Property Value

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?: Excel.ConditionalDataBarRule;

Property Value

Remarks

API set: ExcelApi 1.6

Feedback

Was this page helpful?