Class: MapGarminAutopilotPropsController
Defined in: src/garminsdk/components/map/controllers/MapGarminAutopilotPropsController.ts:42
Binds the properties in a MapGarminAutopilotPropsModule to event bus topics.
Extends
Constructors
Constructor
new MapGarminAutopilotPropsController(
context,bindings,updateFreq?):MapGarminAutopilotPropsController
Defined in: src/garminsdk/components/map/controllers/MapGarminAutopilotPropsController.ts:55
Creates a new instance of MapGarminAutopilotPropsController.
Parameters
| Parameter | Type | Description |
|---|---|---|
context | MapSystemContext<MapGarminAutopilotPropsControllerModules> | This controller's map context. |
bindings | Iterable<MapGarminAutopilotPropsKey | MapGarminAutopilotPropsControllerBinding> | An iterable containing definitions of the bindings to create between module properties and external data sources. |
updateFreq? | null | number | Subscribable<null | number> | The default frequency, in hertz, at which to update the module props from their bound data sources. This frequency, if defined, is applied to all bindings that do not explicitly define their own update frequencies. If the frequency is null, then updates will not be throttled by frequency - each property will be updated as soon as the value of its data source changes. If the frequency is not null, then each property will only be updated when the controller's onBeforeUpdated() method is called, and the frequency of updates will not exceed updateFreq. Ignored if bindings is undefined. |
Returns
MapGarminAutopilotPropsController
Overrides
MapModulePropsController.constructor
Properties
context
protectedreadonlycontext:MapSystemContext<MapModulePropsControllerModules<"autopilotProps",MapGarminAutopilotPropsModule>,any,any,any>
Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24
Inherited from
MapModulePropsController.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
MapModulePropsController.isAlive
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:273
Destroys this controller.
Returns
void
Inherited from
MapModulePropsController.destroy
onAfterMapRender()
onAfterMapRender():
void
Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:254
This method is called after this controller' map is rendered.
Returns
void
Inherited from
MapModulePropsController.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
MapModulePropsController.onAfterUpdated
onBeforeUpdated()
onBeforeUpdated(
time,elapsed):void
Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:261
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
MapModulePropsController.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
MapModulePropsController.onDeadZoneChanged
onMapDestroyed()
onMapDestroyed():
void
Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:268
This method is called when this controller's map is destroyed.
Returns
void
Inherited from
MapModulePropsController.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
MapModulePropsController.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
MapModulePropsController.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