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

Class ZoomLevelRange

Represents a range of zoom levels.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- ZoomLevelRange

Index

Methods

Cast GetHashCode ToString TryCast Equals

Default capability

constructor Unlimited End Start Equals

Methods

Cast

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

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

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, type): 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, objB): 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 ZoomLevelRange(start, end): ZoomLevelRange
Initializes a new instance of the Spotfire.Dxp.Application.Visuals.Maps.ZoomLevelRange class.
Parameters
- start: null | number | Int32
  The starting (farthest) zoom level, or null if not limited to a starting zoom level.
- end: null | number | Int32
  The ending (nearest) zoom level, or null if not limited to an ending zoom level.
Returns ZoomLevelRange
Since
2.0

Overrides Object.constructor

`Static` `Readonly`Unlimited

Unlimited: ZoomLevelRange

The unlimited zoom level range.

Since

2.0

End

get End(): null | number
Gets the ending (nearest) zoom level, or null if not limited to an ending zoom level.

Returns null | number
Since
2.0

Start

get Start(): null | number
Gets the starting (farthest) zoom level, or null if not limited to a starting zoom level.

Returns null | number
Since
2.0

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Overrides Object.Equals
Equals(other): boolean
Indicates whether the current object is equal to another object of the same type.
Parameters
- other: ZoomLevelRange
  An object to compare with this object.
Returns boolean
true if the current object is equal to the other parameter, otherwise false.

Since
2.0

Overrides Object.Equals