Skip to main content

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

ParameterTypeDefault valueDescription
contextMapSystemContext<MapNexradControllerModules, any, any, any>undefinedThis controller's map context.
minRangeIndexnumberundefinedThe minimum range range index, inclusive, at which NEXRAD is visible.
settingManager?UserSettingManager<Partial<MapNexradUserSettings>>undefinedA 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?MapDeclutterModeMapDeclutterMode.Level2The highest global declutter mode, inclusive, at which NEXRAD is visible. Defaults to MapDeclutterMode.Level2. Ignored if settingManager is not defined.

Returns

MapNexradController

Overrides

MapSystemController<MapNexradControllerModules>.constructor

Properties

context

protected readonly context: MapSystemContext<MapNexradControllerModules, 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

destroy()

destroy(): void

Defined in: src/garminsdk/components/map/controllers/MapNexradController.ts:87

Returns

void

Inherit Doc

Overrides

MapSystemController.destroy


onAfterMapRender()

onAfterMapRender(): void

Defined in: src/garminsdk/components/map/controllers/MapNexradController.ts:65

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/MapNexradController.ts:82

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