Class ConditionValue

ConditionValue is used to specify values used in conditional coloring.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- ConditionValue

Index

Methods

Cast ToString TryCast Equals

Default capability

AverageValue Empty MaxValue MedianValue MinValue Type Value Equals GetHashCode CreateExpression CreateLiteral CreatePercentileValue CreatePercentValue

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Default capability

`Static` `Readonly`AverageValue

AverageValue: ConditionValue

A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue of type Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValueType.AverageValue.

Since

2.0

`Static` `Readonly`Empty

Empty: ConditionValue

A empty Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue.

Since

2.0

`Static` `Readonly`MaxValue

MaxValue: ConditionValue

A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue of type Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValueType.MaxValue.

Since

2.0

`Static` `Readonly`MedianValue

MedianValue: ConditionValue

A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue of type Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValueType.MedianValue.

Since

2.0

`Static` `Readonly`MinValue

MinValue: ConditionValue

A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue of type Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValueType.MinValue.

Since

2.0

Type

get Type(): ConditionValueType
Gets the type of this ConditionValue.

Returns ConditionValueType
Since
2.0

Value

get Value(): unknown
Gets the value of this ConditionValue.

Returns unknown
Since
2.0

Equals

Equals(obj: any): boolean
Indicates whether this instance and a specified object are equal.
Parameters
- obj: any
  Another object to compare to.
Returns boolean
true if obj and this instance are the same type and represent the same value; otherwise, false.

Since
2.0

Overrides Object.Equals

GetHashCode

GetHashCode(): number
Returns the hash code for this instance.

Returns number
A 32-bit signed integer that is the hash code for this instance.

Since
2.0

Overrides Object.GetHashCode

`Static`CreateExpression

CreateExpression(expression: string | String): ConditionValue
Creates a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue containing the specified expression.
Parameters
- expression: string | String
  The expression.
Returns ConditionValue
The newly created Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue.

Since
2.0

`Static`CreateLiteral

CreateLiteral(literal: any): ConditionValue
Creates a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue containing the specified literal.
Parameters
- literal: any
  The literal.
Returns ConditionValue
The newly created Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue.

Since
2.0
CreateLiteral(literal: any, dataType: DataType): ConditionValue
Creates a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue containing the specified literal.
Parameters
- literal: any
  The literal.
- dataType: DataType
  The data type for the literal.
Returns ConditionValue
The newly created Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue.

Since
2.0

`Static`CreatePercentileValue

CreatePercentileValue(percentile: number | Double): ConditionValue
Creates a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue containing the specified percentile value.
Parameters
- percentile: number | Double
  The percentile value. The value should be between 0 and 100.
Returns ConditionValue
The newly created Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue.

Since
2.0

`Static`CreatePercentValue

CreatePercentValue(percent: number | Double): ConditionValue
Creates a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue containing the specified percent value.
Parameters
- percent: number | Double
  The percent value. The value should be between 0 and 100.
Returns ConditionValue
The newly created Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue.

Since
2.0

Class ConditionValue

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

Static ReadonlyAverageValue

Since

Static ReadonlyEmpty

Since

Static ReadonlyMaxValue

Since

Static ReadonlyMedianValue

Since

Static ReadonlyMinValue

Since

Type

Returns ConditionValueType

Since

Value

Returns unknown

Since

Equals

Parameters

Returns boolean

Since

GetHashCode

Returns number

Since

StaticCreateExpression

Parameters

Returns ConditionValue

Since

StaticCreateLiteral

Parameters

Returns ConditionValue

Since

Parameters

Returns ConditionValue

Since

StaticCreatePercentileValue

Parameters

Returns ConditionValue

Since

StaticCreatePercentValue

Parameters

Returns ConditionValue

Since

Settings

On This Page

`Static`Equals

`Static` `Readonly`AverageValue

`Static` `Readonly`Empty

`Static` `Readonly`MaxValue

`Static` `Readonly`MedianValue

`Static` `Readonly`MinValue

`Static`CreateExpression

`Static`CreateLiteral

`Static`CreatePercentileValue

`Static`CreatePercentValue