IconCriterion Method

Represents an icon criteria with the specified parameters.

Syntax

Javascript (Usage)
Javascript (Specification)

var value; // Type: any
value = GC.Spread.Sheets.ConditionalFormatting.IconCriterion(isGreaterThanOrEqualTo, iconValueType, iconValue);

function IconCriterion( 
   isGreaterThanOrEqualTo : boolean,
   iconValueType : IconValueType,
   iconValue : object
) : any;

Parameters

isGreaterThanOrEqualTo: If set to true, use the greater than or equal to operator to calculate the value.
iconValueType: The type of scale value.
iconValue: The scale value.

Example

Javascript

//This example creates an icon rule.
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
//rule
var iconSetRule = new GC.Spread.Sheets.ConditionalFormatting.IconSetRule();
iconSetRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
iconSetRule.iconSetType(GC.Spread.Sheets.ConditionalFormatting.IconSetType.fourTrafficLights);
var iconCriteria = iconSetRule.iconCriteria();
iconCriteria[0] = new GC.Spread.Sheets.ConditionalFormatting.IconCriterion(true, GC.Spread.Sheets.ConditionalFormatting.IconValueType.number, 1);
iconCriteria[1] = new GC.Spread.Sheets.ConditionalFormatting.IconCriterion(true, GC.Spread.Sheets.ConditionalFormatting.IconValueType.number, 10);
iconCriteria[2] = new GC.Spread.Sheets.ConditionalFormatting.IconCriterion(true, GC.Spread.Sheets.ConditionalFormatting.IconValueType.number, 20);
iconSetRule.reverseIconOrder(false);
iconSetRule.showIconOnly(false);
activeSheet.conditionalFormats.addRule(iconSetRule);

Reference

ConditionalFormatting type