SetValue

Sets the value for the color scale criterion.

Syntax

expression.SetValue(value);

expression - A variable that represents a ApiColorScaleCriterion class.

Parameters

Name	Required/Optional	Data type	Default	Description
value	Required	string		The value of the color scale criterion.

Returns

This method doesn't return any data.

Example

This example demonstrates setting the value of color scale criterion.

• Code
• Result

// How to change the value of a color scale criterion.

// Set the value of a color scale criterion.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange("A1").SetValue("Test Data");
worksheet.GetRange("A2").SetValue(10);
worksheet.GetRange("A3").SetValue(30);
worksheet.GetRange("A4").SetValue(50);
worksheet.GetRange("A5").SetValue(70);
worksheet.GetRange("A6").SetValue(90);

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

let colorScale = formatConditions.AddColorScale(2);
let criteria = colorScale.GetColorScaleCriteria();

if (criteria && criteria.length > 0) {
    worksheet.GetRange("C1").SetValue("Before:");
    worksheet.GetRange("C2").SetValue(criteria[0].GetValue() || "No value");
    
    criteria[0].SetValue("25");
    
    worksheet.GetRange("C3").SetValue("After:");
    worksheet.GetRange("C4").SetValue(criteria[0].GetValue() || "No value");
}