ConditionalFormattingValue

ConditionalFormattingValue class

Describes the values of the interpolation points in a gradient scale, dataBar or iconSet.

class ConditionalFormattingValue;

Properties

Property	Type	Description
value	Object	Get or set the value of this conditional formatting value object. It should be used in conjunction with Type.
type	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	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.

Methods

Method	Description
getValue()	@deprecated. Please use the ‘value’ property instead. Get or set the value of this conditional formatting value object. It should be used in conjunction with Type.
setValue(Object)	@deprecated. Please use the ‘value’ property instead. Get or set the value of this conditional formatting value object. It should be used in conjunction with Type.
getType()	@deprecated. Please use the ’type’ property instead. 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)	@deprecated. Please use the ’type’ property instead. 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()	@deprecated. Please use the ‘isGTE’ property instead. 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)	@deprecated. Please use the ‘isGTE’ property instead. 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.

value

Get or set the value of this conditional formatting value object. It should be used in conjunction with Type.

value : 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.

type

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.

type : FormatConditionValueType;

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;

getValue()

@deprecated. Please use the ‘value’ property instead. 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)

@deprecated. Please use the ‘value’ property instead. 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()

@deprecated. Please use the ’type’ property instead. 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

FormatConditionValueType

setType(FormatConditionValueType)

@deprecated. Please use the ’type’ property instead. 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()

@deprecated. Please use the ‘isGTE’ property instead. 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)

@deprecated. Please use the ‘isGTE’ property instead. 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;