add3ScaleRule Method

Adds the three scale rule to the rule collection.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.ConditionalFormats(worksheet);
var value; // Type: object
value = instance.add3ScaleRule(minType,
                               minValue,
                               minColor,
                               midType,
                               midValue,
                               midColor,
                               maxType,
                               maxValue,
                               maxColor,
                               ranges);

function add3ScaleRule( 
   minType : ScaleValueType,
   minValue : object,
   minColor : string,
   midType : ScaleValueType,
   midValue : object,
   midColor : string,
   maxType : ScaleValueType,
   maxValue : object,
   maxColor : string,
   ranges : Array
) : object;

Parameters

minType: The minimum scale type.
minValue: The minimum scale value.
minColor: The minimum scale color.
midType: The midpoint scale type.
midValue: The midpoint scale value.
midColor: The midpoint scale color.
maxType: The maximum scale type.
maxValue: The maximum scale value.
maxColor: The maximum scale color.
ranges: The cell ranges where the rule is applied whose item type is GcSpread.Sheets.Range.

Return Value

The three scale rule added to the rule collection.

Example

This example uses the add3ScaleRule method.

Javascript

activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);
activeSheet.getConditionalFormats().add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", [new GcSpread.Sheets.Range(0, 0, 10, 3)]);

Reference

ConditionalFormats type