SpreadJS 13
GC.Spread.Sheets.ConditionalFormatting Namespace / ConditionRuleBase type / ruleType Method
The condition rule type.
In This Topic
    ruleType Method
    In This Topic
    Gets or sets the condition rule type.
    Syntax
    var instance = new GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase(ruleType, style, ranges);
    var returnValue; // Type: any
    returnValue = instance.ruleType(value);
    function ruleType( 
       value : RuleType
    ) : any;

    Parameters

    value
    The condition rule type.

    Return Value

    If no value is set, returns the condition rule type; otherwise, returns the condition rule.
    Example
    This example uses the ruleType method.
    activeSheet.setArray(0,0,[1,2,3,4,5,6,7,8,9,10]);
    var style = new GC.Spread.Sheets.Style();
    style.backColor = "red";
    style.foreColor = "black";
    var cell = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
    cell.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
    cell.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.greaterThan);
    cell.value1(5);
    cell.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
    cell.style(style);
    activeSheet.conditionalFormats.addRule(cell);
    
    var style1 = new GC.Spread.Sheets.Style();
    style1.foreColor = "red";
    var top = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
    top.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
    top.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
    top.rank(3);
    top.style(style1);
    top.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
    top.stopIfTrue(true);
    activeSheet.conditionalFormats.addRule(top);
    See Also