ColorScale
ColorScale class
Describe the ColorScale conditional formatting rule. This conditional formatting rule creates a gradated color scale on the cells.
class ColorScale;
Methods
| Method | Description |
|---|---|
| getIs3ColorScale() | Indicates whether conditional formatting is 3 color scale. |
| setIs3ColorScale(boolean) | Indicates whether conditional formatting is 3 color scale. |
| getMinCfvo() | Get or set this ColorScale’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it. |
| getMidCfvo() | Get or set this ColorScale’s mid value object. Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it. |
| getMaxCfvo() | Get or set this ColorScale’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it. |
| getMinColor() | Get or set the gradient color for the minimum value in the range. |
| setMinColor(Color) | Get or set the gradient color for the minimum value in the range. |
| getMidColor() | Get or set the gradient color for the middle value in the range. |
| setMidColor(Color) | Get or set the gradient color for the middle value in the range. |
| getMaxColor() | Get or set the gradient color for the maximum value in the range. |
| setMaxColor(Color) | Get or set the gradient color for the maximum value in the range. |
| isNull() | Checks whether the implementation object is null. |
getIs3ColorScale()
Indicates whether conditional formatting is 3 color scale.
getIs3ColorScale() : boolean;
setIs3ColorScale(boolean)
Indicates whether conditional formatting is 3 color scale.
setIs3ColorScale(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMinCfvo()
Get or set this ColorScale’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
getMinCfvo() : ConditionalFormattingValue;
Returns
getMidCfvo()
Get or set this ColorScale’s mid value object. Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it.
getMidCfvo() : ConditionalFormattingValue;
Returns
getMaxCfvo()
Get or set this ColorScale’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
getMaxCfvo() : ConditionalFormattingValue;
Returns
getMinColor()
Get or set the gradient color for the minimum value in the range.
getMinColor() : Color;
Returns
setMinColor(Color)
Get or set the gradient color for the minimum value in the range.
setMinColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getMidColor()
Get or set the gradient color for the middle value in the range.
getMidColor() : Color;
Returns
setMidColor(Color)
Get or set the gradient color for the middle value in the range.
setMidColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getMaxColor()
Get or set the gradient color for the maximum value in the range.
getMaxColor() : Color;
Returns
setMaxColor(Color)
Get or set the gradient color for the maximum value in the range.
setMaxColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;