Skip to main content

Class: MapFlightPlanFocusRTRController

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

Controls the pointer of a map.

Extends

Constructors

Constructor

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

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

Constructor.

Parameters

ParameterTypeDefault valueDescription
contextMapSystemContext<MapFlightPlanFocusRTRControllerModules, any, any, MapFlightPlanFocusRTRControllerContext>undefinedThis controller's map context.
nominalFocusMarginsSubscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>undefinedA 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.
defaultFocusRangeIndexnumberundefinedThe default map range index to apply when the flight plan focus consists of only a single point in space.
focusDebounceDelaynumberMapFlightPlanFocusRTRController.DEFAULT_FOCUS_DEBOUNCE_DELAYThe 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

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

Returns

void

Inherit Doc

Overrides

MapSystemController.destroy


onAfterMapRender()

onAfterMapRender(): void

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

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

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

Returns

void

Inherit Doc

Overrides

MapSystemController.onBeforeUpdated


onDeadZoneChanged()

onDeadZoneChanged(): void

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

Returns

void

Inherit Doc

Overrides

MapSystemController.onDeadZoneChanged


onMapDestroyed()

onMapDestroyed(): void

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

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapDestroyed


onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

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

Parameters

ParameterType
mapProjectionMapProjection
changeFlagsnumber

Returns

void

Inherit Doc

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