ConditionalFormattingValue
ConditionalFormattingValue class
Describes the values of the interpolation points in a gradient scale, dataBar or iconSet.
class ConditionalFormattingValue;
Methods
| Method | Description |
|---|---|
| getValue() | Get or set the value of this conditional formatting value object. It should be used in conjunction with Type. |
| setValue(object) | Get or set the value of this conditional formatting value object. It should be used in conjunction with Type. |
| getType() | Get or set the type of this conditional formatting value object. Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max will auto set “Value” to null. |
| setType(FormatConditionValueType) | Get or set the type of this conditional formatting value object. Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max will auto set “Value” to null. |
| isGTE() | Get or set the Greater Than Or Equal flag. Use only for icon sets, determines whether this threshold value uses the greater than or equal to operator. ‘false’ indicates ‘greater than’ is used instead of ‘greater than or equal to’. Default value is true. |
| setIsGTE(boolean) | Get or set the Greater Than Or Equal flag. Use only for icon sets, determines whether this threshold value uses the greater than or equal to operator. ‘false’ indicates ‘greater than’ is used instead of ‘greater than or equal to’. Default value is true. |
| isNull() | Checks whether the implementation object is null. |
getValue()
Get or set the value of this conditional formatting value object. It should be used in conjunction with Type.
getValue() : object;
Remarks
If the value is string and start with “=”, it will be processed as a formula, otherwise we will process it as a simple value.
setValue(object)
Get or set the value of this conditional formatting value object. It should be used in conjunction with Type.
setValue(value: object) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | object | The value to set. |
Remarks
If the value is string and start with “=”, it will be processed as a formula, otherwise we will process it as a simple value.
getType()
Get or set the type of this conditional formatting value object. Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max will auto set “Value” to null.
getType() : FormatConditionValueType;
Returns
setType(FormatConditionValueType)
Get or set the type of this conditional formatting value object. Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max will auto set “Value” to null.
setType(value: FormatConditionValueType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FormatConditionValueType | The value to set. |
isGTE()
Get or set the Greater Than Or Equal flag. Use only for icon sets, determines whether this threshold value uses the greater than or equal to operator. ‘false’ indicates ‘greater than’ is used instead of ‘greater than or equal to’. Default value is true.
isGTE() : boolean;
setIsGTE(boolean)
Get or set the Greater Than Or Equal flag. Use only for icon sets, determines whether this threshold value uses the greater than or equal to operator. ‘false’ indicates ‘greater than’ is used instead of ‘greater than or equal to’. Default value is true.
setIsGTE(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;