Class: MapRangeController
Defined in: src/garminsdk/components/map/controllers/MapRangeController.ts:32
Controls map range.
Extends
MapSystemController<MapRangeControllerModules>
Constructors
Constructor
new MapRangeController(
context,nauticalRangeArray?,metricRangeArray?,settingManager?,useSetting?):MapRangeController
Defined in: src/garminsdk/components/map/controllers/MapRangeController.ts:55
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
context | MapSystemContext<MapRangeControllerModules, any, any, any> | This controller's map context. |
nauticalRangeArray? | readonly NumberUnitInterface<Distance, Unit<Distance>>[] | The map range array this controller sets for nautical distance mode. If not defined, this controller will not change the range array when entering nautical distance mode. |
metricRangeArray? | readonly NumberUnitInterface<Distance, Unit<Distance>>[] | The map range array this controller sets for metric distance mode. If not defined, this controller will not change the range array when entering metric distance mode. |
settingManager? | UserSettingManager<MapRangeControllerSettings> | A setting manager containing the map range index setting. If not defined, map range will be set directly through the map model. |
useSetting? | Subscribable<boolean> | A subscribable which provides whether to control map range via the user setting. If not defined, map range will always be controlled via the user setting. Ignored if settingManager is undefined. |
Returns
MapRangeController
Overrides
MapSystemController<MapRangeControllerModules>.constructor
Properties
context
protectedreadonlycontext:MapSystemContext<MapRangeControllerModules,any,any,any>
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
changeRangeIndex()
changeRangeIndex(
delta,bypassUserSetting):number
Defined in: src/garminsdk/components/map/controllers/MapRangeController.ts:129
Changes the map range index by a given amount. If the change results in an index that is out of bounds, it will be clamped before being set.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
delta | number | undefined | The change to apply to the index. |
bypassUserSetting | boolean | false | Whether to bypass the map range index user setting, if one is defined for this controller, and change the range index directly on the map range module. Defaults to false. |
Returns
number
The final index that was set.
destroy()
destroy():
void
Defined in: src/garminsdk/components/map/controllers/MapRangeController.ts:139
Returns
void
Inherit Doc
Overrides
MapSystemController.destroy
onAfterMapRender()
onAfterMapRender():
void
Defined in: src/garminsdk/components/map/controllers/MapRangeController.ts:68
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
| 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(
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
| 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.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
| Parameter | Type | Description |
|---|---|---|
deadZone | ReadonlyFloat64Array | The map's new dead zone. |
Returns
void
Inherited from
MapSystemController.onDeadZoneChanged
onMapDestroyed()
onMapDestroyed():
void
Defined in: src/garminsdk/components/map/controllers/MapRangeController.ts:134
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
| Parameter | Type | Description |
|---|---|---|
mapProjection | MapProjection | The map projection. |
changeFlags | number | Bit 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
setRangeIndex()
setRangeIndex(
index,bypassUserSetting):number
Defined in: src/garminsdk/components/map/controllers/MapRangeController.ts:109
Sets the map range index. If the index is out of bounds, it will be clamped before being set.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
index | number | undefined | The index to set. |
bypassUserSetting | boolean | false | Whether to bypass the map range index user setting, if one is defined for this controller, and set the range index directly on the map range module. Defaults to false. |
Returns
number
The index that was set.