Class: MapFlightPlanFocusRTRController

Controls the pointer of a map.

Hierarchy

• MapSystemController<MapFlightPlanFocusRTRControllerModules, any, MapFlightPlanFocusRTRControllerControllers, MapFlightPlanFocusRTRControllerContext>

  ↳ MapFlightPlanFocusRTRController

Constructors

constructor

• new MapFlightPlanFocusRTRController(context, nominalFocusMargins, defaultFocusRangeIndex, focusDebounceDelay?): MapFlightPlanFocusRTRController

Constructor.

Parameters

Name	Type	Default value	Description
context	MapSystemContext<MapFlightPlanFocusRTRControllerModules, any, any, MapFlightPlanFocusRTRControllerContext>	undefined	This controller's map context.
nominalFocusMargins	Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>	undefined	A subscribable which provides the nominal focus margins, as [left, top, right, bottom] in pixels. The nominal margins define the offset of the boundaries of the focus region relative to the map's projected window, excluding the dead zone. Positive values represent offsets toward the center of the window. When the flight plan is focused, the focused elements of the plan are guaranteed to be contained within the focus region.
defaultFocusRangeIndex	number	undefined	The default map range index to apply when the flight plan focus consists of only a single point in space.
focusDebounceDelay	number	MapFlightPlanFocusRTRController.DEFAULT_FOCUS_DEBOUNCE_DELAY	The debounce delay, in milliseconds, to apply to focus target calculations when the flight plan focus changes. Defaults to 500 milliseconds.

Returns

MapFlightPlanFocusRTRController

Overrides

MapSystemController\< MapFlightPlanFocusRTRControllerModules, any, MapFlightPlanFocusRTRControllerControllers, MapFlightPlanFocusRTRControllerContext \>.constructor

Defined in

src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:175

Properties

context

• Protected Readonly context: MapSystemContext<MapFlightPlanFocusRTRControllerModules, any, MapFlightPlanFocusRTRControllerControllers, MapFlightPlanFocusRTRControllerContext>

Inherited from

MapSystemController.context

Defined in

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

---

mapTargetParam

• Protected Readonly mapTargetParam: Object

Type declaration

Name	Type
target	GeoPoint

Defined in

src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:71

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/MapFlightPlanFocusRTRController.ts:358

---

onAfterMapRender

▸ onAfterMapRender(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onAfterMapRender

Defined in

src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:205

---

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(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onBeforeUpdated

Defined in

src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:342

---

onDeadZoneChanged

▸ onDeadZoneChanged(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onDeadZoneChanged

Defined in

src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:187

---

onMapDestroyed

▸ onMapDestroyed(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapDestroyed

Defined in

src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:353

---

onMapProjectionChanged

▸ onMapProjectionChanged(mapProjection, changeFlags): void

Parameters

Name	Type
mapProjection	MapProjection
changeFlags	number

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapProjectionChanged

Defined in

src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:335

---

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