Class: MapWxrModule
A module that describes the display of weather on a Bing Map instance.
Constructors
constructor
• new MapWxrModule(): MapWxrModule
Returns
Properties
isEnabled
• Readonly
isEnabled: Subject
<boolean
>
Whether the weather radar is enabled.
Defined in
src/sdk/components/mapsystem/modules/MapWxrModule.ts:14
weatherRadarArc
• Readonly
weatherRadarArc: NumberUnitSubject
<Angle
, SimpleUnit
<Angle
>>
The current map weather radar arc sweep angle in degrees.
Defined in
src/sdk/components/mapsystem/modules/MapWxrModule.ts:17
weatherRadarColors
• Readonly
weatherRadarColors: ArraySubject
<readonly [number
, number
]>
The current weather radar colors. Each entry E_i
of the array is a tuple [color, rate]
that defines a color
stop, where color
is an RGBA color expressed as R + G * 256 + B * 256^2 + A * 256^3
and rate
is a
precipitation rate in millimeters per hour.
In general, the color defined by E_i
is applied to precipitation rates ranging from the rate defined by E_i-1
to the rate defined by E_i
. There are two special cases. The color defined by E_0
is applied to the
precipitation rates from zero to the rate defined by E_0
. The color defined by E_n-1
, where n
is the length
of the array, is applied to the precipitation rates from the rate defined by E_n-2
to positive infinity.
Defined in
src/sdk/components/mapsystem/modules/MapWxrModule.ts:32
weatherRadarMode
• Readonly
weatherRadarMode: Subject
<TOPVIEW
| HORIZONTAL
| VERTICAL
>
The current weather radar mode.
Defined in
src/sdk/components/mapsystem/modules/MapWxrModule.ts:20
Accessors
wxrMode
• get
wxrMode(): Subscribable
<WxrMode
>
A subscribable containing the combined WxrMode from the mode and arc subjects, suitable for consumption in a MapBingLayer.
Returns
The WxrMode subscribable.
Defined in
src/sdk/components/mapsystem/modules/MapWxrModule.ts:51