Skip to main content

Class: MapNexradController

Controls the display of NEXRAD based on user settings.

Hierarchy

Constructors

constructor

new MapNexradController(context, minRangeIndex, settingManager?, maxDeclutterMode?): MapNexradController

Creates a new instance of MapNexradController.

Parameters

NameTypeDefault 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.
maxDeclutterModeMapDeclutterModeMapDeclutterMode.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

Defined in

src/garminsdk/components/map/controllers/MapNexradController.ts:52

Properties

context

Protected Readonly context: MapSystemContext<MapNexradControllerModules, 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/MapNexradController.ts:87


onAfterMapRender

onAfterMapRender(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onAfterMapRender

Defined in

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


onAfterUpdated

onAfterUpdated(time, elapsed): void

This method is called immediately after this controller's map updates its layers.

Parameters

NameTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe 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

NameTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe 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

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


onMapProjectionChanged

onMapProjectionChanged(mapProjection, changeFlags): void

This method is called when the projection of this controller's map changes.

Parameters

NameTypeDescription
mapProjectionMapProjectionThe map projection.
changeFlagsnumberBit 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