Skip to main content

Class: MapIndexedRangeModule

A module describing the nominal range of a map.

Constructors​

constructor​

• new MapIndexedRangeModule(): MapIndexedRangeModule

Returns​

MapIndexedRangeModule

Inherit Doc

Defined in​

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

Properties​

nominalRange​

• Readonly nominalRange: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

The nominal range.

Defined in​

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

nominalRangeIndex​

• Readonly nominalRangeIndex: Subscribable<number>

The index of the nominal range.

Defined in​

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

nominalRanges​

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

The array of possible map nominal ranges.

Defined in​

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

Methods​

setNominalRangeIndex​

▸ setNominalRangeIndex(index): NumberUnitInterface<Distance, Unit<Distance>>

Sets the nominal range by index.

Parameters​

NameTypeDescription
indexnumberThe index of the new nominal range.

Returns​

NumberUnitInterface<Distance, Unit<Distance>>

The value of the new nominal range.

Throws

Error if index of out of bounds.

Defined in​

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