SpreadJS 13
SpreadJS Documentation / Developer's Guide / Features / Manage Data Visualization and Objects / Conditional Formatting / Average Rule
In This Topic
    Average Rule
    In This Topic

    The average rule checks for values above or below the average.

    The following image displays an example of the average rule.

    Average rule

    Using Code

    This example creates an average rule.

    JavaScript
    Copy Code
    activeSheet.setValue(0,0, 1,3);
    activeSheet.setValue(1,0, 50,3);
    activeSheet.setValue(2,0, 100,3);
    activeSheet.setValue(3,0, 2,3);
    activeSheet.setValue(4,0, 60,3);
    activeSheet.setValue(5,0, 90,3);
    activeSheet.setValue(6,0, 3,3);
    activeSheet.setValue(7,0, 40,3);
    activeSheet.setValue(8,0, 70,3);
    activeSheet.setValue(9,0, 5,3);
    activeSheet.setValue(10,0, 35,3);
    var style = new GC.Spread.Sheets.Style();
    style.backColor = "red";
    style.borderLeft =new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    style.borderTop = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    style.borderRight = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    style.borderBottom = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    activeSheet.conditionalFormats.addAverageRule(GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.Above, style, [new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
    // OR
    activeSheet.setValue(0,0, 1,3);
    activeSheet.setValue(1,0, 50,3);
    activeSheet.setValue(2,0, 100,3);
    activeSheet.setValue(3,0, 2,3);
    activeSheet.setValue(4,0, 60,3);
    activeSheet.setValue(5,0, 90,3);
    activeSheet.setValue(6,0, 3,3);
    activeSheet.setValue(7,0, 40,3);
    activeSheet.setValue(8,0, 70,3);
    activeSheet.setValue(9,0, 5,3);
    activeSheet.setValue(10,0, 35,3);
    var style = new GC.Spread.Sheets.Style();
    style.backColor = "red";
    style.borderLeft =new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    style.borderTop = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    style.borderRight = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    style.borderBottom = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
    var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
    rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.AverageRule);
    rule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
    rule.style(style);
    rule.type(GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.Above);
    activeSheet.conditionalFormats.addRule(rule);
    
    See Also