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

    Parameters

    value
    The minimum scale value.

    Return Value

    If no value is set, returns the minimum scale value; otherwise, returns the scale rule.
    Example
    The following examples use the minValue 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.minColor() + " Type: " + scale.minType() + " Value: " + scale.minValue());
    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.minColor() + " Type: " + scale.minType() + " Value: " + scale.minValue());
    activeSheet.setValue(0,0,1,3);
    activeSheet.setValue(1,0,15,3);
    activeSheet.setValue(2,0,25,3);
    activeSheet.setValue(3,0,-1,3);
    
    var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
    dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
    dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    dataBarRule.minValue(-1);
    dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    dataBarRule.maxValue(40);
    dataBarRule.color("green");
    dataBarRule.showBorder(true);
    dataBarRule.borderColor("orange");
    dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
    dataBarRule.negativeFillColor("yellow");
    dataBarRule.useNegativeFillColor(true);
    dataBarRule.negativeBorderColor("red");
    dataBarRule.useNegativeBorderColor(true);
    dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
    dataBarRule.axisColor("blue");
    dataBarRule.showBarOnly(false);
    activeSheet.conditionalFormats.addRule(dataBarRule);
    See Also

    Reference

    ScaleRule class