SpreadJS Documentation
IconSetRule class
GC.Spread.Sheets.ConditionalFormatting Namespace : IconSetRule class
Represents an icon set rule with the specified parameters.
Syntax
var instance = new GC.Spread.Sheets.ConditionalFormatting.IconSetRule(iconSetType, ranges);
function IconSetRule;
Example
//This example creates a new icon set rule and sets the range and icon for it.
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
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 icons = iconSetRule.icons();
icons[0] = {iconSetType: GC.Spread.Sheets.ConditionalFormatting.IconSetType.fiveArrowsColored, iconIndex: 1};
icons[1] = {iconSetType: GC.Spread.Sheets.ConditionalFormatting.IconSetType.fiveArrowsColored, iconIndex: 2};
icons[2] = {iconSetType: GC.Spread.Sheets.ConditionalFormatting.IconSetType.noIcons, iconIndex: 0};

* 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);
Inheritance Hierarchy

Object
   GC.Spread.Sheets.ConditionalFormatting.ScaleRule
      GC.Spread.Sheets.ConditionalFormatting.IconSetRule

Constructors
 NameDescription
public ConstructorRepresents an icon set rule with the specified parameters.  
Top
Methods
 NameDescription
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public MethodReturns the specified value of the rule if the cell meets the condition.  
public Methodstatic (Shared in Visual Basic)Gets the icon based on the specific iconSetType and iconIndex objects.  
public MethodGets the icon criteria.  
public MethodGets or sets the icons.  
public MethodGets or sets the type of icon set.  
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
public MethodResets the rule.  
public MethodGets or sets whether to reverse icon order.  
public MethodGets or sets whether to display the icon only.  
public Method (Inherited from GC.Spread.Sheets.ConditionalFormatting.ScaleRule)
Top
See Also

Reference

GC.Spread.Sheets.ConditionalFormatting Namespace
Using Conditional Formatting