Skip to main content

Class: WaypointMapRTRController

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

Hierarchy

Constructors

constructor

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

Constructor.

Parameters

NameTypeDescription
contextMapSystemContext<WaypointMapRTRControllerModules, any, any, WaypointMapRTRControllerContext>This controller's map context.
supportAirportAutoRangebooleanWhether 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, "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\< WaypointMapRTRControllerModules, any, WaypointMapRTRControllerControllers, WaypointMapRTRControllerContext \>.constructor

Defined in

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

Properties

context

Protected Readonly context: MapSystemContext<WaypointMapRTRControllerModules, any, WaypointMapRTRControllerControllers, WaypointMapRTRControllerContext>

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/WaypointMapRTRController.ts:292


onAfterMapRender

onAfterMapRender(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onAfterMapRender

Defined in

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


onAfterUpdated

onAfterUpdated(time, elapsed): void

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

Parameters

NameTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe 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

NameTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe 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

NameTypeDescription
deadZoneReadonly<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/WaypointMapRTRController.ts:287


onMapProjectionChanged

onMapProjectionChanged(mapProjection, changeFlags): void

Parameters

NameType
mapProjectionMapProjection
changeFlagsnumber

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapProjectionChanged

Defined in

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


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


tryTargetWaypoint

tryTargetWaypoint(resetRange): boolean

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

NameTypeDescription
resetRangebooleanWhether 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.

Defined in

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