Excel.DataBarConditionalFormat class

Represents an Excel Conditional Data Bar Type.

[ API set: ExcelApi 1.6 ]

Extends
OfficeExtension.ClientObject

Properties

axisColor

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

[ API set: ExcelApi 1.6 ]

axisFormat

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

[ API set: ExcelApi 1.6 ]

barDirection

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

[ API set: ExcelApi 1.6 ]

lowerBoundRule

The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.

[ API set: ExcelApi 1.6 ]

negativeFormat

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

[ API set: ExcelApi 1.6 ]

positiveFormat

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

[ API set: ExcelApi 1.6 ]

showDataBarOnly

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

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

[ API set: ExcelApi 1.6 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Property Details

axisColor

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

[ API set: ExcelApi 1.6 ]

axisColor: string;
Property Value
string

axisFormat

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

[ API set: ExcelApi 1.6 ]

axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";
Property Value
Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"

barDirection

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

[ API set: ExcelApi 1.6 ]

barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";
Property Value
Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.dataBar);
    conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;

    await context.sync();
});

lowerBoundRule

The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.

[ API set: ExcelApi 1.6 ]

lowerBoundRule: Excel.ConditionalDataBarRule;
Property Value

negativeFormat

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

[ API set: ExcelApi 1.6 ]

readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;
Property Value

positiveFormat

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

[ API set: ExcelApi 1.6 ]

readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;
Property Value

showDataBarOnly

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

[ API set: ExcelApi 1.6 ]

showDataBarOnly: boolean;
Property Value
boolean

upperBoundRule

The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.

[ API set: ExcelApi 1.6 ]

upperBoundRule: Excel.ConditionalDataBarRule;
Property Value

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.DataBarConditionalFormat;
Parameters
option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.DataBarConditionalFormat - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataBarConditionalFormat - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

toJSON(): Excel.Interfaces.DataBarConditionalFormatData;
Returns