ig.excel.ColorScaleConditionalFormat
Remarks
This class support either a 2-color or 3-color scale, as determined by the value of the colorScaleType parameter of the constructor.
For 2-color scales, cells in the associated range are colored based on how their value relates to the minimum and maximum thresholds.
For 3-color scales, cells in the associated range are colored based on how their value relates to the minimum, midpoint, and maximum thresholds.
This class supports a maximum of three separate and distinct color thresholds.
Specifying only one threshold is not supported and may result in unexpected behavior.
If this instance is created as a 2-color scale, the ColorScaleConditionalFormat.midpointThreshold property is not applicable. Attempting to set a property on the object returned from the MidpointThreshold property in this case will cause an exception to be thrown.
Dependencies
-
colorScaleType
- .colorScaleType( );
- Return Type:
- ig.excel.ColorScaleType
- Return Type Description:
- Returns a ColorScaleType.
Returns a ColorScaleType value which identifies this instance as a 2-color or 3-color scale.
Remarks
A ColorScaleConditionalFormat instance which is created with the 'TwoColor' value does not support the ColorScaleConditionalFormat.midpointThreshold; attempting to set a property on the object retuned from the MidpointThreshold property will cause an exception to be thrown.
See Also
-
maximumThreshold
- .maximumThreshold( );
- Return Type:
- ig.excel.ColorScaleCriterion
- Return Type Description:
- Returns a ColorScaleCriterion.
Returns a ColorScaleCriterion object which defines the properties of the maximum threshold for this instance.
Remarks
The following value types are not valid for the maximum threshold, and will cause an exception to be thrown:
- LowestValue
- AutomaticMinimum
- AutomaticMaximum
-
midpointThreshold
- .midpointThreshold( );
- Return Type:
- ig.excel.ColorScaleCriterion
- Return Type Description:
- Returns a ColorScaleCriterion.
Returns a ColorScaleCriterion object which defines the properties of the midpoint threshold for this instance.
Remarks
The midpoint threshold is only supported for a ColorScaleConditionalFormat instance with a value of 'ThreeColor' specified for the colorScaleType parameter.
Attempting to set a property on the instance returned from this property will cause an exception to be thrown if this instance was created as a 2-color scale.
The following value types are not valid for the midpoint threshold, and will cause an exception to be thrown:
- LowestValue
- HighestValue
- AutomaticMinimum
- AutomaticMaximum
-
minimumThreshold
- .minimumThreshold( );
- Return Type:
- ig.excel.ColorScaleCriterion
- Return Type Description:
- Returns a ColorScaleCriterion.
Returns a ColorScaleCriterion object which defines the properties of the minimum threshold for this instance.
Remarks
The minimum threshold defines the criteria for the lowest or minimum value across the associated range.
For a 2-color scale, the ColorScaleConditionalFormat.maximumThreshold defines the next "stop"; for a 3-color scale, the ColorScaleConditionalFormat.midpointThreshold property defines the next stop.
The following value types are not valid for the minimum threshold, and will cause an exception to be thrown:
- HighestValue
- AutomaticMinimum
- AutomaticMaximum