NegativeBarFormat

NegativeBarFormat class

Represents the color settings of the data bars for negative values that are defined by a data bar conditional formatting rule.

class NegativeBarFormat;

Properties

PropertyTypeDescription
borderColorColorGets or sets a FormatColor object that you can use to specify the border color for negative data bars.
borderColorTypeDataBarNegativeColorTypeGets whether to use the same border color as positive data bars.
colorColorGets or sets a FormatColor object that you can use to specify the fill color for negative data bars.
colorTypeDataBarNegativeColorTypeGets or sets whether to use the same fill color as positive data bars.

Methods

MethodDescription
getBorderColor()@deprecated. Please use the ‘borderColor’ property instead. Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.
setBorderColor(Color)@deprecated. Please use the ‘borderColor’ property instead. Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.
getBorderColorType()@deprecated. Please use the ‘borderColorType’ property instead. Gets whether to use the same border color as positive data bars.
setBorderColorType(DataBarNegativeColorType)@deprecated. Please use the ‘borderColorType’ property instead. Gets whether to use the same border color as positive data bars.
getColor()@deprecated. Please use the ‘color’ property instead. Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.
setColor(Color)@deprecated. Please use the ‘color’ property instead. Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.
getColorType()@deprecated. Please use the ‘colorType’ property instead. Gets or sets whether to use the same fill color as positive data bars.
setColorType(DataBarNegativeColorType)@deprecated. Please use the ‘colorType’ property instead. Gets or sets whether to use the same fill color as positive data bars.
isNull()Checks whether the implementation object is null.

borderColor

Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.

borderColor : Color;

borderColorType

Gets whether to use the same border color as positive data bars.

borderColorType : DataBarNegativeColorType;

color

Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.

color : Color;

colorType

Gets or sets whether to use the same fill color as positive data bars.

colorType : DataBarNegativeColorType;

getBorderColor()

@deprecated. Please use the ‘borderColor’ property instead. Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.

getBorderColor() : Color;

Returns

Color

setBorderColor(Color)

@deprecated. Please use the ‘borderColor’ property instead. Gets or sets a FormatColor object that you can use to specify the border color for negative data bars.

setBorderColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getBorderColorType()

@deprecated. Please use the ‘borderColorType’ property instead. Gets whether to use the same border color as positive data bars.

getBorderColorType() : DataBarNegativeColorType;

Returns

DataBarNegativeColorType

setBorderColorType(DataBarNegativeColorType)

@deprecated. Please use the ‘borderColorType’ property instead. Gets whether to use the same border color as positive data bars.

setBorderColorType(value: DataBarNegativeColorType) : void;

Parameters:

ParameterTypeDescription
valueDataBarNegativeColorTypeThe value to set.

getColor()

@deprecated. Please use the ‘color’ property instead. Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.

getColor() : Color;

Returns

Color

setColor(Color)

@deprecated. Please use the ‘color’ property instead. Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars.

setColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getColorType()

@deprecated. Please use the ‘colorType’ property instead. Gets or sets whether to use the same fill color as positive data bars.

getColorType() : DataBarNegativeColorType;

Returns

DataBarNegativeColorType

setColorType(DataBarNegativeColorType)

@deprecated. Please use the ‘colorType’ property instead. Gets or sets whether to use the same fill color as positive data bars.

setColorType(value: DataBarNegativeColorType) : void;

Parameters:

ParameterTypeDescription
valueDataBarNegativeColorTypeThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;