About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class Range

A Range represents a double-precision floating-point interval.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- Range

Index

Methods

Cast TryCast Equals

Default capability

constructor EmptyRange InvalidRange UnitRange High IsEmptyRange IsUnitRange IsValidRange Low Midpoint Width Clamp Contains Equals GetHashCode ToString

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

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
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 T1 | null
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

constructor

new Range(range: Spotfire.Dxp.Data.Range): Spotfire.Dxp.Data.Range
Initializes a new instance of the Spotfire.Dxp.Data.Range struct. Copy constructor.
Parameters
- range: Spotfire.Dxp.Data.Range
  Range to copy.
Returns Spotfire.Dxp.Data.Range
Since
2.0

Overrides Object.constructor
new Range(
low: number | System.Double,
high: number | System.Double,
): Spotfire.Dxp.Data.Range
Initializes a new instance of the Spotfire.Dxp.Data.Range struct.
Parameters
- low: number | System.Double
  The low limit of the range
- high: number | System.Double
  The high limit of the range
Returns Spotfire.Dxp.Data.Range
Since
2.0

Overrides Object.constructor

`Static` `Readonly`EmptyRange

EmptyRange: Spotfire.Dxp.Data.Range

Empty range. Both Low and High are 0.

Since

2.0

`Static` `Readonly`InvalidRange

InvalidRange: Spotfire.Dxp.Data.Range

Invalid range. No operations except IsInvalid are allowed.

Since

2.0

`Static` `Readonly`UnitRange

UnitRange: Spotfire.Dxp.Data.Range

Unit range. Low is 0 and High is 1.

Since

2.0

High

get High(): number
Gets the high limit of the range.

Returns number
Since
2.0

IsEmptyRange

get IsEmptyRange(): boolean
Gets a value indicating whether the range is empty or not.True Returns true if the range is an empty (point) interval.

Returns boolean
Since
2.0

IsUnitRange

get IsUnitRange(): boolean
Gets a value indicating whether the range is a unit range. Returns true if the range is a unit range [0, 1].

Returns boolean
Since
2.0

IsValidRange

get IsValidRange(): boolean
Gets a value indicating whether the range is valid or not.

Returns boolean
Since
2.0

Low

get Low(): number
Gets the low limit of the range.

Returns number
Since
2.0

Midpoint

get Midpoint(): number
Gets the mid-point of the range. Equal to (Low + High)/2.

Returns number
Since
2.0

Width

get Width(): number
Gets the width of the range. Equal to High - Low.

Returns number
Since
2.0

Clamp

Clamp(value: number | System.Double): number
Clamps the specified value to this range. That is, the returned value will be within this range.
Parameters
- value: number | System.Double
  The value.
Returns number
Clamped value.

Since
2.0

Contains

Contains(value: number | System.Double): boolean
Determines whether the specified value is within the range.
Parameters
- value: number | System.Double
  The value to check.
Returns boolean
true if the specified value is within the range; otherwise, false.

Since
2.0

Equals

Equals(obj: any): boolean
Compare for equality.
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
Calculates hash code for a range.

Returns number
The hashcode

Since
2.0

Overrides Object.GetHashCode

ToString

ToString(): string
Returns a string representation of the range.

Returns string
String representation of the range.

Since
2.0

Overrides Object.ToString