Class: MapIndexedRangeModule

Defined in: src/sdk/components/map/modules/MapIndexedRangeModule.ts:9

A module describing the nominal range of a map.

Constructors

Constructor

new MapIndexedRangeModule(): MapIndexedRangeModule

Defined in: src/sdk/components/map/modules/MapIndexedRangeModule.ts:21

Returns

MapIndexedRangeModule

Inherit Doc

Properties

nominalRange

readonly nominalRange: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

Defined in: src/sdk/components/map/modules/MapIndexedRangeModule.ts:18

The nominal range.

---

nominalRangeIndex

readonly nominalRangeIndex: Subscribable<number>

Defined in: src/sdk/components/map/modules/MapIndexedRangeModule.ts:11

The index of the nominal range.

---

nominalRanges

readonly nominalRanges: Subject<readonly NumberUnitInterface<Distance, Unit<Distance>>[]>

Defined in: src/sdk/components/map/modules/MapIndexedRangeModule.ts:14

The array of possible map nominal ranges.

Methods

setNominalRangeIndex()

setNominalRangeIndex(index): NumberUnitInterface<Distance>

Defined in: src/sdk/components/map/modules/MapIndexedRangeModule.ts:40

Sets the nominal range by index.

Parameters

Parameter	Type	Description
index	number	The index of the new nominal range.

Returns

NumberUnitInterface<Distance>

The value of the new nominal range.

Throws

Error if index of out of bounds.