Class: WaypointMapRTRController

Defined in: src/garminsdk/components/map/controllers/WaypointMapRTRController.ts:47

Controls the target and range of a waypoint map based on the selected waypoint.

Extends

• MapSystemController<WaypointMapRTRControllerModules, any, WaypointMapRTRControllerControllers, WaypointMapRTRControllerContext>

Constructors

Constructor

new WaypointMapRTRController(context, supportAirportAutoRange, defaultAirportRangeIndex?, airportAutoRangeMargins?): WaypointMapRTRController

Defined in: src/garminsdk/components/map/controllers/WaypointMapRTRController.ts:123

Constructor.

Parameters

Parameter	Type	Description
context	MapSystemContext<WaypointMapRTRControllerModules, any, any, WaypointMapRTRControllerContext>	This controller's map context.
supportAirportAutoRange	boolean	Whether this controller automatically adjusts the map range when an airport is the highlighted waypoint to give an appropriate view of the selected runway, or all runways if there is no selected runway.
defaultAirportRangeIndex?	Subscribable<number>	A subscribable which provides the default map range index to apply when a range cannot be automatically selected for an airport. Ignored if supportAirportAutoRange is false. If not defined, the map range will not be reset when targeting an airport and a range cannot be automatically selected.
airportAutoRangeMargins?	Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>	The nominal margins (relative to the map's dead zone boundaries), to respect when calculating the map range for airports, as [left, top, right, bottom] in pixels. Ignored if supportAirportAutoRange is false. Defaults to [0, 0, 0, 0].

Returns

WaypointMapRTRController

Overrides

MapSystemController.constructor

Properties

context

protected readonly context: MapSystemContext<WaypointMapRTRControllerModules, any, WaypointMapRTRControllerControllers, WaypointMapRTRControllerContext>

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

Inherited from

MapSystemController.context

Accessors

isAlive

Get Signature

get isAlive(): boolean

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

Whether this controller is alive.

Returns

boolean

Inherited from

MapSystemController.isAlive

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/map/controllers/WaypointMapRTRController.ts:292

Destroys this controller.

Returns

void

Overrides

MapSystemController.destroy

---

onAfterMapRender()

onAfterMapRender(): void

Defined in: src/garminsdk/components/map/controllers/WaypointMapRTRController.ts:142

This method is called after this controller' map is rendered.

Returns

void

Overrides

MapSystemController.onAfterMapRender

---

onAfterUpdated()

onAfterUpdated(time, elapsed): void

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

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

Parameters

Parameter	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

---

onBeforeUpdated()

onBeforeUpdated(time, elapsed): void

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

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

Parameters

Parameter	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

---

onDeadZoneChanged()

onDeadZoneChanged(deadZone): void

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

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

Parameters

Parameter	Type	Description
deadZone	ReadonlyFloat64Array	The map's new dead zone.

Returns

void

Inherited from

MapSystemController.onDeadZoneChanged

---

onMapDestroyed()

onMapDestroyed(): void

Defined in: src/garminsdk/components/map/controllers/WaypointMapRTRController.ts:287

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

Returns

void

Overrides

MapSystemController.onMapDestroyed

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/garminsdk/components/map/controllers/WaypointMapRTRController.ts:179

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

Parameters

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

Returns

void

Overrides

MapSystemController.onMapProjectionChanged

---

onSleep()

onSleep(): void

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

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

Returns

void

Inherited from

MapSystemController.onSleep

---

onWake()

onWake(): void

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

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

Returns

void

Inherited from

MapSystemController.onWake

---

tryTargetWaypoint()

tryTargetWaypoint(resetRange): boolean

Defined in: src/garminsdk/components/map/controllers/WaypointMapRTRController.ts:192

Attempts to target the map to the selected waypoint. If there is no selected waypoint or this controller does not have map target or range control privileges, this method does nothing.

Parameters

Parameter	Type	Description
resetRange	boolean	Whether to reset the map range if the selected waypoint is an airport and airport auto-range is supported.

Returns

boolean

Whether the map was successfully targeted.