GetNegativeBorderColor
Returns the negative bar border color of the data bar.
Syntax
expression.GetNegativeBorderColor();
expression - A variable that represents a ApiDatabar class.
Parameters
This method doesn't have any parameters.
Returns
ApiColor | null
Example
This example demonstrates getting the negative bar border color from a data bar conditional formatting rule.
- Code
- Result
// How to retrieve the border color of negative value bars.
// Get the negative bar border color of a data bar conditional formatting rule.
let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("Sales Data");
worksheet.GetRange("A2").SetValue(-50);
worksheet.GetRange("A3").SetValue(250);
worksheet.GetRange("A4").SetValue(-25);
worksheet.GetRange("A5").SetValue(300);
worksheet.GetRange("A6").SetValue(75);
let dataRange = worksheet.GetRange("A2:A6");
let formatConditions = dataRange.GetFormatConditions();
let dataBar = formatConditions.AddDatabar();
let negativeBorderColor = dataBar.GetNegativeBorderColor();
worksheet.GetRange("C1").SetValue("Negative Border:");
worksheet.GetRange("C2").SetValue(negativeBorderColor ? "Set" : "None");