Interface: WeatherRadarProps
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:29
Component props for WeatherRadar.
Extends
ComponentProps
Properties
arcBounds?
optional
arcBounds:MutableSubscribable
<any
,Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>>>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:110
A mutable subscribable to bind to the bounding rect of the radar arc, as [left, top, right, bottom]
in pixels.
arcOrigin?
optional
arcOrigin:MutableSubscribable
<any
,Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>>>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:104
A mutable subscribable to bind to the position of the center of the radar arc, as [x, y]
in pixels.
arcRadius?
optional
arcRadius:MutableSubscribable
<any
,number
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:107
A mutable subscribable to bind to the radius of the radar arc, in pixels.
bingId
bingId:
string
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:31
The unique ID to assign to the weather radar's Bing instance.
bus
bus:
EventBus
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:34
The event bus.
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
ComponentProps.children
colors
colors: readonly readonly [
number
,number
][] |Subscribable
<readonly readonly [number
,number
][]>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:74
The colors for the weather radar at zero gain. Each entry E_i
of the array is a tuple [color, dBZ]
that
defines a color stop, where color
is an RGBA color expressed as R + G * 256 + B * 256^2 + A * 256^3
and dBZ
is a return signal strength.
In general, the color defined by E_i
is applied to returns ranging from the signal strength defined by E_i-1
to the signal strength defined by E_i
. There are two special cases. The color defined by E_0
is applied to
returns with signal strengths from negative infinity to the strength defined by E_0
. The color defined by
E_n-1
, where n
is the length of the array, is applied to returns with signal strengths from the strength
defined by E_n-2
to positive infinity.
gain
gain:
Subscribable
<number
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:77
The gain of the weather radar, in dBZ.
horizontalScanAngularWidth
horizontalScanAngularWidth:
number
|Subscribable
<number
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:43
The angular width, in degrees, of the radar arc in horizontal scan mode.
horizontalScanPadding?
optional
horizontalScanPadding:Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>> |Subscribable
<Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>>>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:86
The padding inside the weather radar display respected by the radar arc in horizontal scan mode, as
[left, top, right, bottom]
in pixels. Defaults to [0, 0, 0, 0]
.
isDataFailed
isDataFailed:
Subscribable
<boolean
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:80
Whether weather radar data is in a failure state.
operatingMode
operatingMode:
Subscribable
<WeatherRadarOperatingMode
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:37
The operating mode of the weather radar.
range
range:
Subscribable
<NumberUnitInterface
<Distance
,Unit
<Distance
>>>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:49
The display range of the weather radar.
rangeUnit
rangeUnit:
Unit
<Distance
> |Subscribable
<Unit
<Distance
>>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:52
The units displayed by the weather radar's range labels.
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
ComponentProps.ref
referenceLineAngularWidth?
optional
referenceLineAngularWidth:number
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:101
The angular width of the reference line, in degrees. Defaults to 0 degrees.
scanMode
scanMode:
Subscribable
<WeatherRadarScanMode
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:40
The scan mode of the weather radar.
showBearingLine
showBearingLine:
Subscribable
<boolean
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:58
Whether to show the bearing line in horizontal scan mode.
showTiltLine
showTiltLine:
Subscribable
<boolean
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:61
Whether to show the tilt line in vertical scan mode.
size
size:
Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>> |Subscribable
<Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>>>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:55
The size of the weather radar display, as [width, height]
in pixels.
verticalRangeLineExtend?
optional
verticalRangeLineExtend:number
|Subscribable
<number
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:98
The amount the vertical range lines extend outward from the boundaries of the radar arc, in pixels. Defaults to 0 pixels.
verticalScanAngularWidth
verticalScanAngularWidth:
number
|Subscribable
<number
>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:46
The angular width, in degrees, of the radar arc in vertical scan mode.
verticalScanPadding?
optional
verticalScanPadding:Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>> |Subscribable
<Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>>>
Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:92
The padding inside the weather radar display respected by the radar arc in vertical scan mode, as
[left, top, right, bottom]
in pixels. Defaults to [0, 0, 0, 0]
.