Class: MapFlightPlanFocusRTRController

Defined in: src/garminsdk/components/map/controllers/MapFlightPlanFocusRTRController.ts:57

Controls the pointer of a map.

Extends

• MapSystemController<MapFlightPlanFocusRTRControllerModules, any, MapFlightPlanFocusRTRControllerControllers, MapFlightPlanFocusRTRControllerContext>

Constructors

Constructor

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

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

Constructor.

Parameters

Parameter	Type	Default value	Description
context	MapSystemContext<MapFlightPlanFocusRTRControllerModules, any, any, MapFlightPlanFocusRTRControllerContext>	undefined	This controller's map context.
nominalFocusMargins	Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "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.constructor

Properties

context

protected readonly context: MapSystemContext<MapFlightPlanFocusRTRControllerModules, any, MapFlightPlanFocusRTRControllerControllers, MapFlightPlanFocusRTRControllerContext>

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

Inherited from

MapSystemController.context

---

mapTargetParam

protected readonly mapTargetParam: object

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

target

target: GeoPoint

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

Destroys this controller.

Returns

void

Overrides

MapSystemController.destroy

---

onAfterMapRender()

onAfterMapRender(): void

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

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

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

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

Returns

void

Overrides

MapSystemController.onBeforeUpdated

---

onDeadZoneChanged()

onDeadZoneChanged(): void

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

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

Returns

void

Overrides

MapSystemController.onDeadZoneChanged

---

onMapDestroyed()

onMapDestroyed(): void

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

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

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