Skip to main content

Class: MapOrientationModeController

Defined in: src/garminsdk/components/map/controllers/MapOrientationModeController.ts:28

Controls the orientation of a map based on the desired orientation mode.

Extends​

Constructors​

Constructor​

new MapOrientationModeController(context): MapOrientationModeController

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

Constructor.

Parameters​

ParameterTypeDescription
contextMapSystemContext<MapOrientationModeControllerModules, any, any, MapOrientationModeControllerContext>This controller's map context.

Returns​

MapOrientationModeController

Inherited from​

MapSystemController<MapOrientationModeControllerModules, any, any, MapOrientationModeControllerContext>.constructor

Properties​

context​

protected readonly context: MapSystemContext<MapOrientationModeControllerModules, any, any, MapOrientationModeControllerContext>

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/MapOrientationModeController.ts:62

Returns​

void

Inherit Doc​

Overrides​

MapSystemController.destroy


onAfterMapRender()​

onAfterMapRender(): void

Defined in: src/garminsdk/components/map/controllers/MapOrientationModeController.ts:50

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(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​

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

ParameterTypeDescription
deadZoneReadonlyFloat64ArrayThe map's new dead zone.

Returns​

void

Inherited from​

MapSystemController.onDeadZoneChanged


onMapDestroyed()​

onMapDestroyed(): void

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

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​

ParameterTypeDescription
mapProjectionMapProjectionThe map projection.
changeFlagsnumberBit 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