Class: MapOrientationSettingsController
Controls the orientation of a map based on user settings.
Hierarchy
MapSystemController<MapOrientationSettingsControllerModules>↳
MapOrientationSettingsController
Constructors
constructor
• new MapOrientationSettingsController(context, settingManager): MapOrientationSettingsController
Creates a new instance of MapOrientationSettingsController.
Parameters
| Name | Type | Description |
|---|---|---|
context | MapSystemContext<MapOrientationSettingsControllerModules> | This controller's map context. |
settingManager | UserSettingManager<Partial<MapOrientationSettingsControllerSettings>> | The setting manager used by this controller. |
Returns
MapOrientationSettingsController
Overrides
MapSystemController\<MapOrientationSettingsControllerModules\>.constructor
Defined in
src/garminsdk/components/map/controllers/MapOrientationSettingsController.ts:42
Properties
context
• Protected Readonly context: MapSystemContext<MapOrientationSettingsControllerModules, any, any, any>
Inherited from
MapSystemController.context
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:24
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/MapOrientationSettingsController.ts:86
onAfterMapRender
▸ onAfterMapRender(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onAfterMapRender
Defined in
src/garminsdk/components/map/controllers/MapOrientationSettingsController.ts:50
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(time, elapsed): void
This method is called immediately before 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.onBeforeUpdated
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:68
onDeadZoneChanged
▸ onDeadZoneChanged(deadZone): void
This method is called when the dead zone of this controller's map changes.
Parameters
| Name | Type | Description |
|---|---|---|
deadZone | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The map's new dead zone. |
Returns
void
Inherited from
MapSystemController.onDeadZoneChanged
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:48
onMapDestroyed
▸ onMapDestroyed(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onMapDestroyed
Defined in
src/garminsdk/components/map/controllers/MapOrientationSettingsController.ts:81
onMapProjectionChanged
▸ onMapProjectionChanged(mapProjection, changeFlags): void
This method is called when the projection of this controller's map changes.
Parameters
| Name | Type | Description |
|---|---|---|
mapProjection | MapProjection | The map projection. |
changeFlags | number | Bit flags describing the type of change. |
Returns
void
Inherited from
MapSystemController.onMapProjectionChanged
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:58
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