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

Class AxisRange

Structure used to control the range of an axis.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- AxisRange

Index

Methods

Cast TryCast Equals

Default capability

constructor DefaultRange High Low 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>): 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

constructor

new AxisRange(low: any, high: any): AxisRange
Initializes a new instance of the Spotfire.Dxp.Application.Visuals.AxisRange class.
Parameters
- low: any
  The lower limit of the range, or null if the low value should be derived from the data.
- high: any
  The upper limit of the range, or null if the low value should be derived from the data.
Returns AxisRange
Since
2.0

Overrides Object.constructor

`Static` `Readonly`DefaultRange

DefaultRange: AxisRange

Gets an open range, that is, a range where both high and low limits are null.

Since

2.0

High

get High(): unknown
Gets the high value.

Returns unknown
Remark
This value may be null, in which case the the low value is automatically derived from the data.

Since
2.0

Low

get Low(): unknown
Gets the low value.

Returns unknown
Remark
This value may be null, in which case the the low value is automatically derived from the data.

Since
2.0

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  Instance to check for equality.
Returns boolean
true if the specified object is equal to the current object; 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

ToString

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

Returns string
A string representing this object.

Since
2.0

Overrides Object.ToString