Class: MapNexradController
Defined in: src/garminsdk/components/map/controllers/MapNexradController.ts:32
Controls the display of NEXRAD based on user settings.
Extends
Constructors
Constructor
new MapNexradController(
context
,minRangeIndex
,settingManager?
,maxDeclutterMode?
):MapNexradController
Defined in: src/garminsdk/components/map/controllers/MapNexradController.ts:52
Creates a new instance of MapNexradController.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
context | MapSystemContext <MapNexradControllerModules , any , any , any > | undefined | This controller's map context. |
minRangeIndex | number | undefined | The minimum range range index, inclusive, at which NEXRAD is visible. |
settingManager? | UserSettingManager <Partial <MapNexradUserSettings >> | undefined | A setting manager containing the user settings controlling the display of NEXRAD. If not defined, the display of NEXRAD will not be bound to user settings. |
maxDeclutterMode? | MapDeclutterMode | MapDeclutterMode.Level2 | The highest global declutter mode, inclusive, at which NEXRAD is visible. Defaults to MapDeclutterMode.Level2 . Ignored if settingManager is not defined. |
Returns
MapNexradController
Overrides
MapSystemController
.constructor
Properties
context
protected
readonly
context:MapSystemContext
<MapNexradControllerModules
,any
,any
,any
>
Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24
Inherited from
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
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/map/controllers/MapNexradController.ts:87
Destroys this controller.
Returns
void
Overrides
onAfterMapRender()
onAfterMapRender():
void
Defined in: src/garminsdk/components/map/controllers/MapNexradController.ts:65
This method is called after this controller' map is rendered.
Returns
void
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/MapNexradController.ts:82
This method is called when this controller's map is destroyed.
Returns
void
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
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