SpreadJS 13
GC.Spread.Sheets.ConditionalFormatting Namespace / ScaleRule class / maxColor Method
The maximum color scale.
In This Topic
    maxColor Method
    In This Topic
    Gets or sets the maximum color scale.
    Syntax
    var instance = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
    var returnValue; // Type: any
    returnValue = instance.maxColor(value);
    function maxColor( 
       value : string
    ) : any;

    Parameters

    value
    The maximum color scale.

    Return Value

    If no value is set, returns the maximum color scale; otherwise, returns the scale rule.
    Example
    The following examples use the maxColor method.
    var rule = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
    rule.ranges([new GC.Spread.Sheets.Range(0,0,10,3)]);
    rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.twoScaleRule);
    rule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    rule.minValue(10);
    rule.minColor("Yellow");
    rule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    rule.maxValue(100);
    rule.maxColor("Blue");
    activeSheet.conditionalFormats.addRule(rule);
    activeSheet.setValue(0,0, 1,3);
    activeSheet.setValue(1,0, 50,3);
    activeSheet.setValue(2,0, 100,3);
    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);
    var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
    scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.twoScaleRule);
    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);
    alert("Color: " + scale.maxColor() + " Type: " + scale.maxType() + " Value: " + scale.maxValue());
    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);
    alert("Color: " + scale.maxColor() + " Type: " + scale.maxType() + " Value: " + scale.maxValue());
    Remarks
    The default value is rgba(255, 99, 190, 123).
    See Also

    Reference

    ScaleRule class