Class: NearestMapRTRController
Defined in: src/garminsdk/components/map/controllers/NearestMapRTRController.ts:41
Controls the range of a nearest waypoint map to keep a highlighted waypoint in view.
Extends
MapSystemController<NearestMapRTRControllerModules,any,NearestMapRTRControllerControllers,NearestMapRTRControllerContext>
Constructors
Constructor
new NearestMapRTRController(
context,defaultNoTargetRangeIndex):NearestMapRTRController
Defined in: src/garminsdk/components/map/controllers/NearestMapRTRController.ts:73
Constructor.
Parameters
| Parameter | 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
Properties
context
protectedreadonlycontext:MapSystemContext<NearestMapRTRControllerModules,any,NearestMapRTRControllerControllers,NearestMapRTRControllerContext>
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/NearestMapRTRController.ts:129
Returns
void
Inherit Doc
Overrides
MapSystemController.destroy
onAfterMapRender()
onAfterMapRender():
void
Defined in: src/garminsdk/components/map/controllers/NearestMapRTRController.ts:81
Returns
void
Inherit Doc
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/NearestMapRTRController.ts:124
Returns
void
Inherit Doc
Overrides
MapSystemController.onMapDestroyed
onMapProjectionChanged()
onMapProjectionChanged(
mapProjection,changeFlags):void
Defined in: src/sdk/components/mapsystem/MapSystemController.ts:58
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
Inherited from
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
trySetRangeForWaypoint()
trySetRangeForWaypoint():
void
Defined in: src/garminsdk/components/map/controllers/NearestMapRTRController.ts:91
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