Class: MapIndexedScaleFactorModule

Defined in: src/sdk/components/map/modules/MapIndexedScaleFactorModule.ts:8

A module describing the nominal scale factor of a map, as selected from an array of scale factors.

Constructors

Constructor

new MapIndexedScaleFactorModule(): MapIndexedScaleFactorModule

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

Creates a new instance of MapIndexedScaleFactorModule.

Returns

MapIndexedScaleFactorModule

Properties

nominalScaleFactor

readonly nominalScaleFactor: Subscribable<number>

Defined in: src/sdk/components/map/modules/MapIndexedScaleFactorModule.ts:16

The nominal scale factor.

---

nominalScaleFactorIndex

readonly nominalScaleFactorIndex: Subscribable<number>

Defined in: src/sdk/components/map/modules/MapIndexedScaleFactorModule.ts:10

The index of the nominal scale factor.

---

nominalScaleFactors

readonly nominalScaleFactors: Subject<readonly number[]>

Defined in: src/sdk/components/map/modules/MapIndexedScaleFactorModule.ts:13

The array of possible map nominal scale factors.

Methods

setNominalScaleFactorIndex()

setNominalScaleFactorIndex(index): number

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

Sets the nominal scale factor by index.

Parameters

Parameter	Type	Description
index	number	The index of the new nominal scale factor.

Returns

number

The value of the new nominal scale factor.

Throws

Error if index of out of bounds.