ColorScale
ColorScale class
Describe the ColorScale conditional formatting rule. This conditional formatting rule creates a gradated color scale on the cells.
class ColorScale;
Properties
Property | Type | Description |
---|---|---|
is3ColorScale | boolean | Indicates whether conditional formatting is 3 color scale. |
minCfvo | ConditionalFormattingValue | Readonly. Get or set this ColorScale’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it. |
midCfvo | ConditionalFormattingValue | Readonly. Get or set this ColorScale’s mid value object. Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it. |
maxCfvo | ConditionalFormattingValue | Readonly. Get or set this ColorScale’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it. |
minColor | Color | Get or set the gradient color for the minimum value in the range. |
midColor | Color | Get or set the gradient color for the middle value in the range. |
maxColor | Color | Get or set the gradient color for the maximum value in the range. |
Methods
Method | Description |
---|---|
getIs3ColorScale() | @deprecated. Please use the ‘is3ColorScale’ property instead. Indicates whether conditional formatting is 3 color scale. |
setIs3ColorScale(boolean) | @deprecated. Please use the ‘is3ColorScale’ property instead. Indicates whether conditional formatting is 3 color scale. |
getMinCfvo() | @deprecated. Please use the ‘minCfvo’ property instead. Get or set this ColorScale’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it. |
getMidCfvo() | @deprecated. Please use the ‘midCfvo’ property instead. Get or set this ColorScale’s mid value object. Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it. |
getMaxCfvo() | @deprecated. Please use the ‘maxCfvo’ property instead. Get or set this ColorScale’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it. |
getMinColor() | @deprecated. Please use the ‘minColor’ property instead. Get or set the gradient color for the minimum value in the range. |
setMinColor(Color) | @deprecated. Please use the ‘minColor’ property instead. Get or set the gradient color for the minimum value in the range. |
getMidColor() | @deprecated. Please use the ‘midColor’ property instead. Get or set the gradient color for the middle value in the range. |
setMidColor(Color) | @deprecated. Please use the ‘midColor’ property instead. Get or set the gradient color for the middle value in the range. |
getMaxColor() | @deprecated. Please use the ‘maxColor’ property instead. Get or set the gradient color for the maximum value in the range. |
setMaxColor(Color) | @deprecated. Please use the ‘maxColor’ property instead. Get or set the gradient color for the maximum value in the range. |
isNull() | Checks whether the implementation object is null. |
is3ColorScale
Indicates whether conditional formatting is 3 color scale.
is3ColorScale : boolean;
minCfvo
Readonly. Get or set this ColorScale’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
minCfvo : ConditionalFormattingValue;
midCfvo
Readonly. Get or set this ColorScale’s mid value object. Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it.
midCfvo : ConditionalFormattingValue;
maxCfvo
Readonly. Get or set this ColorScale’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
maxCfvo : ConditionalFormattingValue;
minColor
Get or set the gradient color for the minimum value in the range.
minColor : Color;
midColor
Get or set the gradient color for the middle value in the range.
midColor : Color;
maxColor
Get or set the gradient color for the maximum value in the range.
maxColor : Color;
getIs3ColorScale()
@deprecated. Please use the ‘is3ColorScale’ property instead. Indicates whether conditional formatting is 3 color scale.
getIs3ColorScale() : boolean;
setIs3ColorScale(boolean)
@deprecated. Please use the ‘is3ColorScale’ property instead. Indicates whether conditional formatting is 3 color scale.
setIs3ColorScale(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getMinCfvo()
@deprecated. Please use the ‘minCfvo’ property instead. Get or set this ColorScale’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
getMinCfvo() : ConditionalFormattingValue;
Returns
getMidCfvo()
@deprecated. Please use the ‘midCfvo’ property instead. 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()
@deprecated. Please use the ‘maxCfvo’ property instead. Get or set this ColorScale’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
getMaxCfvo() : ConditionalFormattingValue;
Returns
getMinColor()
@deprecated. Please use the ‘minColor’ property instead. Get or set the gradient color for the minimum value in the range.
getMinColor() : Color;
Returns
setMinColor(Color)
@deprecated. Please use the ‘minColor’ property instead. 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()
@deprecated. Please use the ‘midColor’ property instead. Get or set the gradient color for the middle value in the range.
getMidColor() : Color;
Returns
setMidColor(Color)
@deprecated. Please use the ‘midColor’ property instead. 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()
@deprecated. Please use the ‘maxColor’ property instead. Get or set the gradient color for the maximum value in the range.
getMaxColor() : Color;
Returns
setMaxColor(Color)
@deprecated. Please use the ‘maxColor’ property instead. 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;