Skip to main content

Interface: WeatherRadarProps

Component props for WeatherRadar.

Hierarchy​

  • ComponentProps

    ↳ WeatherRadarProps

Properties​

arcBounds​

• Optional arcBounds: MutableSubscribable<any, Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

A mutable subscribable to bind to the bounding rect of the radar arc, as [left, top, right, bottom] in pixels.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:110

arcOrigin​

• Optional arcOrigin: MutableSubscribable<any, Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

A mutable subscribable to bind to the position of the center of the radar arc, as [x, y] in pixels.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:104

arcRadius​

• Optional arcRadius: MutableSubscribable<any, number>

A mutable subscribable to bind to the radius of the radar arc, in pixels.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:107

bingId​

• bingId: string

The unique ID to assign to the weather radar's Bing instance.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:31

bus​

• bus: EventBus

The event bus.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:34

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

ComponentProps.children

Defined in​

src/sdk/components/FSComponent.ts:122

colors​

• colors: readonly readonly [number, number][] | Subscribable<readonly readonly [number, number][]>

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.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:74

gain​

• gain: Subscribable<number>

The gain of the weather radar, in dBZ.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:77

horizontalScanAngularWidth​

• horizontalScanAngularWidth: number | Subscribable<number>

The angular width, in degrees, of the radar arc in horizontal scan mode.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:43

horizontalScanPadding​

• Optional horizontalScanPadding: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

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].

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:86

isDataFailed​

• isDataFailed: Subscribable<boolean>

Whether weather radar data is in a failure state.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:80

operatingMode​

• operatingMode: Subscribable<WeatherRadarOperatingMode>

The operating mode of the weather radar.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:37

range​

• range: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

The display range of the weather radar.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:49

rangeUnit​

• rangeUnit: Unit<Distance> | Subscribable<Unit<Distance>>

The units displayed by the weather radar's range labels.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:52

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

ComponentProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125

referenceLineAngularWidth​

• Optional referenceLineAngularWidth: number

The angular width of the reference line, in degrees. Defaults to 0 degrees.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:101

scanMode​

• scanMode: Subscribable<WeatherRadarScanMode>

The scan mode of the weather radar.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:40

showBearingLine​

• showBearingLine: Subscribable<boolean>

Whether to show the bearing line in horizontal scan mode.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:58

showTiltLine​

• showTiltLine: Subscribable<boolean>

Whether to show the tilt line in vertical scan mode.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:61

size​

• size: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

The size of the weather radar display, as [width, height] in pixels.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:55

verticalRangeLineExtend​

• Optional verticalRangeLineExtend: number | Subscribable<number>

The amount the vertical range lines extend outward from the boundaries of the radar arc, in pixels. Defaults to 0 pixels.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:98

verticalScanAngularWidth​

• verticalScanAngularWidth: number | Subscribable<number>

The angular width, in degrees, of the radar arc in vertical scan mode.

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:46

verticalScanPadding​

• Optional verticalScanPadding: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

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].

Defined in​

src/garminsdk/components/weatherradar/WeatherRadar.tsx:92