SpreadJS 13
GC.Spread.Sheets.ConditionalFormatting Namespace / ConditionalFormats type / addRule Method
The rule to add.
In This Topic
    addRule Method
    In This Topic
    Adds the rule.
    Syntax
    var instance = new GC.Spread.Sheets.ConditionalFormatting.ConditionalFormats(worksheet);
    var value; // Type: ConditionRuleBase
    value = instance.addRule(rule);
    function addRule( 
       rule : ConditionRuleBase
    ) : ConditionRuleBase;

    Parameters

    rule
    The rule to add.
    Example
    This example uses the addRule method.
    var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
    scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.threeScaleRule);
    scale.midColor("red");
    scale.midType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    scale.midValue(50);
    scale.maxColor("blue");
    scale.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    scale.maxValue(100);
    scale.minColor("yellow");
    scale.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    scale.minValue(10);
    scale.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
    activeSheet.conditionalFormats.addRule(scale);
    activeSheet.setValue(0,0, 1,3);
    activeSheet.setValue(1,0, 50,3);
    activeSheet.setValue(2,0, 100,3);
    See Also