SpreadJS Documentation
GC.Spread.Sheets Namespace / ConditionalFormatting type / IconSetRule Method
The type of icon set.
In This Topic
    IconSetRule Method
    In This Topic
    Represents an icon set rule with the specified parameters.
    Syntax
    var value; // Type: any
    value = GC.Spread.Sheets.ConditionalFormatting.IconSetRule(iconSetType, ranges);
    function IconSetRule( 
       iconSetType : IconSetType,
       ranges : undefined
    ) : any;

    Parameters

    iconSetType
    The type of icon set.
    ranges
    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);
    See Also