useNegativeBorderColor Method

Gets or sets a value that indicates whether the negative border color is used to paint the border for the negative value.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.DataBarRule(minType, minValue, maxType, maxValue, color);
var returnValue; // Type: boolean
returnValue = instance.useNegativeBorderColor(value);

function useNegativeBorderColor( 
   value : boolean
) : boolean;

Parameters

value: Whether the negative border color is used to paint the border for the negative value.

Return Value

The value that indicates whether the negative border color is used to paint the border for the negative value.

Example

This example uses the useNegativeBorderColor method.

Javascript

activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);

var cfs = activeSheet.getConditionalFormats();
var dataBarRule = new GcSpread.Sheets.DataBarRule();
dataBarRule.ranges=[new GcSpread.Sheets.Range(0,0,4,1)];
dataBarRule.minimumType(GcSpread.Sheets.ScaleValueType.Number);
dataBarRule.minimumValue(-1);
dataBarRule.maximumType(GcSpread.Sheets.ScaleValueType.Number);
dataBarRule.maximumValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GcSpread.Sheets.BarDirection.LeftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GcSpread.Sheets.DataBarAxisPosition.Automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
cfs.addRule(dataBarRule);

Remarks

The default value is false.

Reference

DataBarRule class