Class: MapWxrModule
Defined in: src/sdk/components/mapsystem/modules/MapWxrModule.ts:12
A module that describes the display of weather on a Bing Map instance.
Constructors
Constructor
new MapWxrModule():
MapWxrModule
Returns
MapWxrModule
Properties
isEnabled
readonly
isEnabled:Subject
<boolean
>
Defined in: src/sdk/components/mapsystem/modules/MapWxrModule.ts:14
Whether the weather radar is enabled.
weatherRadarArc
readonly
weatherRadarArc:NumberUnitSubject
<Angle
,SimpleUnit
<Angle
>>
Defined in: src/sdk/components/mapsystem/modules/MapWxrModule.ts:17
The current map weather radar arc sweep angle in degrees.
weatherRadarColors
readonly
weatherRadarColors:ArraySubject
<readonly [number
,number
]>
Defined in: src/sdk/components/mapsystem/modules/MapWxrModule.ts:32
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.
weatherRadarMode
readonly
weatherRadarMode:Subject
<TOPVIEW
|HORIZONTAL
|VERTICAL
>
Defined in: src/sdk/components/mapsystem/modules/MapWxrModule.ts:20
The current weather radar mode.
Accessors
wxrMode
Get Signature
get wxrMode():
Subscribable
<WxrMode
>
Defined in: src/sdk/components/mapsystem/modules/MapWxrModule.ts:51
A subscribable containing the combined WxrMode from the mode and arc subjects, suitable for consumption in a MapBingLayer.
Returns
The WxrMode subscribable.