Excel.ConditionalDataBarNegativeFormat class

Represents a conditional format DataBar Format for the negative side of the data bar.

[ API set: ExcelApi 1.6 ]

Extends
OfficeExtension.ClientObject

Properties

borderColor

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

[ API set: ExcelApi 1.6 ]

fillColor

HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").

[ API set: ExcelApi 1.6 ]

matchPositiveBorderColor

Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.

[ API set: ExcelApi 1.6 ]

matchPositiveFillColor

Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.

[ 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

borderColor

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

[ API set: ExcelApi 1.6 ]

borderColor: string;
Property Value
string

fillColor

HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").

[ API set: ExcelApi 1.6 ]

fillColor: string;
Property Value
string

matchPositiveBorderColor

Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.

[ API set: ExcelApi 1.6 ]

matchPositiveBorderColor: boolean;
Property Value
boolean

matchPositiveFillColor

Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.

[ API set: ExcelApi 1.6 ]

matchPositiveFillColor: boolean;
Property Value
boolean

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