Class: NearestMapRTRController

Controls the range of a nearest waypoint map to keep a highlighted waypoint in view.

Hierarchy

• MapSystemController<NearestMapRTRControllerModules, any, NearestMapRTRControllerControllers, NearestMapRTRControllerContext>

  ↳ NearestMapRTRController

Constructors

constructor

• new NearestMapRTRController(context, defaultNoTargetRangeIndex): NearestMapRTRController

Constructor.

Parameters

Name	Type	Description
context	MapSystemContext<NearestMapRTRControllerModules, any, any, NearestMapRTRControllerContext>	This controller's map context.
defaultNoTargetRangeIndex	null | Subscribable<number>	A subscribable which provides the default map range index to apply when not targeting a waypoint, or null if no range index should be applied.

Returns

NearestMapRTRController

Overrides

MapSystemController\< NearestMapRTRControllerModules, any, NearestMapRTRControllerControllers, NearestMapRTRControllerContext \>.constructor

Defined in

src/garminsdk/components/map/controllers/NearestMapRTRController.ts:73

Properties

context

• Protected Readonly context: MapSystemContext<NearestMapRTRControllerModules, any, NearestMapRTRControllerControllers, NearestMapRTRControllerContext>

Inherited from

MapSystemController.context

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:24

Accessors

isAlive

• get isAlive(): boolean

Whether this controller is alive.

Returns

boolean

Inherited from

MapSystemController.isAlive

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:20

Methods

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.destroy

Defined in

src/garminsdk/components/map/controllers/NearestMapRTRController.ts:129

---

onAfterMapRender

▸ onAfterMapRender(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onAfterMapRender

Defined in

src/garminsdk/components/map/controllers/NearestMapRTRController.ts:81

---

onAfterUpdated

▸ onAfterUpdated(time, elapsed): void

This method is called immediately after this controller's map updates its layers.

Parameters

Name	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapSystemController.onAfterUpdated

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:78

---

onBeforeUpdated

▸ onBeforeUpdated(time, elapsed): void

This method is called immediately before this controller's map updates its layers.

Parameters

Name	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapSystemController.onBeforeUpdated

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:68

---

onDeadZoneChanged

▸ onDeadZoneChanged(deadZone): void

This method is called when the dead zone of this controller's map changes.

Parameters

Name	Type	Description
deadZone	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The map's new dead zone.

Returns

void

Inherited from

MapSystemController.onDeadZoneChanged

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:48

---

onMapDestroyed

▸ onMapDestroyed(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapDestroyed

Defined in

src/garminsdk/components/map/controllers/NearestMapRTRController.ts:124

---

onMapProjectionChanged

▸ onMapProjectionChanged(mapProjection, changeFlags): void

This method is called when the projection of this controller's map changes.

Parameters

Name	Type	Description
mapProjection	MapProjection	The map projection.
changeFlags	number	Bit flags describing the type of change.

Returns

void

Inherited from

MapSystemController.onMapProjectionChanged

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:58

---

onSleep

▸ onSleep(): void

This method is called when this controller's map is put to sleep.

Returns

void

Inherited from

MapSystemController.onSleep

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:92

---

onWake

▸ onWake(): void

This method is called when this controller's map is awakened.

Returns

void

Inherited from

MapSystemController.onWake

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:85

---

trySetRangeForWaypoint

▸ trySetRangeForWaypoint(): void

Attempts to set the range of this controller's map so that the highlighted waypoint is in view. If there is no highlighted waypoint or this controller does not have map range control privileges, this method does nothing.

Returns

void

Defined in

src/garminsdk/components/map/controllers/NearestMapRTRController.ts:91