Skip to main content

GetFillColor

Returns the background color for the format condition.

Returns 'No Fill' when the background color of the format condition is null.

Inherited from ApiFormatCondition.GetFillColor.

Syntax​

expression.GetFillColor();

expression - A variable that represents an ApiTop10 class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiColor | 'No Fill'

Example​

Read the background color set by a top 10 conditional formatting rule in a spreadsheet.

// How do I find out what fill color a top 10 conditional formatting rule uses in a spreadsheet?

// Confirm which highlight color marks the top values in a spreadsheet.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange("A1").SetValue("Sales Data");
worksheet.GetRange("A2").SetValue(100);
worksheet.GetRange("A3").SetValue(250);
worksheet.GetRange("A4").SetValue(150);
worksheet.GetRange("A5").SetValue(300);
worksheet.GetRange("A6").SetValue(75);

let dataRange = worksheet.GetRange("A2:A6");
let formatConditions = dataRange.GetFormatConditions();

let condition1 = formatConditions.AddTop10();
condition1.SetFillColor(Api.CreateColorFromRGB(255, 255, 0));

let fillColor = condition1.GetFillColor();

worksheet.GetRange("C1").SetValue("Fill color retrieved");
worksheet.GetRange("C2").SetValue("Top 2 values highlighted");