SpreadJS 13
GC.Spread.Sheets.ConditionalFormatting Namespace / IconSetRule class / iconSetType Method
The type of icon set.
In This Topic
    iconSetType Method
    In This Topic
    Gets or sets the type of icon set.
    Syntax
    var instance = new GC.Spread.Sheets.ConditionalFormatting.IconSetRule(iconSetType, ranges);
    var returnValue; // Type: any
    returnValue = instance.iconSetType(value);
    function iconSetType( 
       value : IconSetType
    ) : any;

    Parameters

    value
    The type of icon set.

    Return Value

    If no value is set, returns the type of icon set; otherwise, returns the icon set rule.
    Example
    This example creates a 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);
    
    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);
    See Also