Interface: BingComponentProps

Defined in: src/sdk/components/bing/BingComponent.tsx:33

Component props for the MapComponent.

Extends

• ComponentProps

Properties

children?

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from

ComponentProps.children

---

class?

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/bing/BingComponent.tsx:105

CSS class(es) to add to the Bing component's image.

---

delay?

optional delay: number

Defined in: src/sdk/components/bing/BingComponent.tsx:95

The amount of time, in milliseconds, to delay binding the Bing instance after the component has been rendered. Defaults to 0.

---

earthColors?

optional earthColors: SubscribableArray<number>

Defined in: src/sdk/components/bing/BingComponent.tsx:51

The earth colors for the Bing component. Index 0 defines the water color, and indexes 1 to the end of the array define the terrain colors. Each color should be expressed as R + G * 256 + B * 256^2. If not defined, all colors default to black.

---

earthColorsElevationRange?

optional earthColorsElevationRange: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/bing/BingComponent.tsx:60

The elevation range over which to assign the earth terrain colors, as [minimum, maximum] in feet. The terrain colors are assigned at regular intervals over the entire elevation range, starting with the first terrain color at the minimum elevation and ending with the last terrain color at the maximum elevation. Terrain below and above the minimum and maximum elevation are assigned the first and last terrain colors, respectively. Defaults to [0, 30000].

---

id

id: string

Defined in: src/sdk/components/bing/BingComponent.tsx:35

The unique ID to assign to this Bing component.

---

isoLines?

optional isoLines: Subscribable<boolean>

Defined in: src/sdk/components/bing/BingComponent.tsx:89

Whether isolines should be shown. Defaults to false.

---

mode

mode: EBingMode

Defined in: src/sdk/components/bing/BingComponent.tsx:38

The mode of the Bing component.

---

onBoundCallback()?

optional onBoundCallback: (component) => void

Defined in: src/sdk/components/bing/BingComponent.tsx:41

A callback to call when the Bing component is bound.

Parameters

Parameter	Type
component	BingComponent

Returns

void

---

ref?

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

ComponentProps.ref

---

reference?

optional reference: Subscribable<EBingReference>

Defined in: src/sdk/components/bing/BingComponent.tsx:69

The reference mode for the Bing component. Defaults to EBingReference.SEA.

---

resolution?

optional resolution: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/bing/BingComponent.tsx:44

The internal resolution for the Bing component, as [width, height] in pixels. Defaults to 1024x1024 pixels.

---

skipUnbindOnDestroy?

optional skipUnbindOnDestroy: boolean

Defined in: src/sdk/components/bing/BingComponent.tsx:102

Whether to skip unbinding the component's bound Bing instance when the component is destroyed. This option should be set to true if other components are sharing the same Bing instance and the other components need the Bing instance to remain bound after the component is destroyed. Defaults to false.

---

skyColor?

optional skyColor: Subscribable<number>

Defined in: src/sdk/components/bing/BingComponent.tsx:66

The sky color for the Bing component. The sky color is only visible in synthetic vision (EBingMode.HORIZON) mode. The color should be expressed as R + G * 256 + B * 256^2. Defaults to black.

---

wxrColors?

optional wxrColors: SubscribableArray<readonly [number, number]>

Defined in: src/sdk/components/bing/BingComponent.tsx:86

The weather radar colors for the Bing component. 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.

If not defined, the colors default to BingComponent.DEFAULT_WEATHER_COLORS.

---

wxrMode?

optional wxrMode: Subscribable<WxrMode>

Defined in: src/sdk/components/bing/BingComponent.tsx:72

The weather radar mode for the Bing component. Defaults to EWeatherRadar.NONE.