Skip to main content

GetType

Returns the type of the color scale criterion.

Syntax​

expression.GetType();

expression - A variable that represents a ApiColorScaleCriterion class.

Parameters​

This method doesn't have any parameters.

Returns​

XlConditionValueTypes | null

Example​

Read the threshold type assigned to a color scale rule point in a spreadsheet.

// How do I find out what kind of threshold is set for a color scale rule point in a spreadsheet?

// Inspect the threshold category of a color scale rule entry to understand how its boundary is defined in a spreadsheet.

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) {
    let criterionType = criteria[0].GetType();
    
    worksheet.GetRange("C1").SetValue("Criterion Type:");
    worksheet.GetRange("C2").SetValue(criterionType);
}