SpreadJS 13
GC.Spread.Sheets.ConditionalFormatting Namespace / NormalConditionRule class / rank Method
The number of top or bottom items to apply the style to.
In This Topic
    rank Method
    In This Topic
    Gets or sets the number of top or bottom items to apply the style to.
    Syntax
    var instance = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule(ruleType, ranges, style, operator, value1, value2, text, formula, type, rank);
    var returnValue; // Type: any
    returnValue = instance.rank(value);
    function rank( 
       value : number
    ) : any;

    Parameters

    value
    The number of top or bottom items to apply the style to.

    Return Value

    If no value is set, returns the number of top or bottom items to apply the style to; otherwise, returns the number condition rule.
    Example
    This example creates multiple rules.
    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