Class: BingComponent

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

A FSComponent that displays the MSFS Bing Map, weather radar, and 3D terrain.

Extends

• DisplayComponent<BingComponentProps>

Constructors

Constructor

new BingComponent(props): BingComponent

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	BingComponentProps	The propertis of the component.

Returns

BingComponent

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: BingComponentProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

DEFAULT_RESOLUTION

readonly static DEFAULT_RESOLUTION: 1024 = 1024

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

The default resolution of the Bing Map along both horizontal and vertical axes, in pixels.

---

DEFAULT_WEATHER_COLORS

readonly static DEFAULT_WEATHER_COLORS: readonly readonly [number, number][]

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

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext

---

isAwake()

isAwake(): boolean

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

Checks whether this Bing component is awake.

Returns

boolean

whether this Bing component is awake.

---

isBound()

isBound(): boolean

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

Checks whether this Bing component has been bound.

Returns

boolean

whether this Bing component has been bound.

---

onAfterRender()

onAfterRender(): void

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

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

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

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

resetImgSrc()

resetImgSrc(): void

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

Resets the img element's src attribute.

Returns

void

---

setPositionRadius()

setPositionRadius(pos, radius): void

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

Sets the center position and radius.

Parameters

Parameter	Type	Description
pos	LatLong	The center position.
radius	number	The radius, in meters.

Returns

void

---

sleep()

sleep(): void

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

Puts this Bing component to sleep. While asleep, this component cannot make changes to the Bing instance to which it is bound.

Returns

void

---

wake()

wake(): void

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

Wakes this Bing component. Upon awakening, this component will synchronize its state to the Bing instance to which it is bound.

Returns

void

---

createEarthColorsArray()

static createEarthColorsArray(waterColor, terrainColors, minElevation, maxElevation, stepCount): number[]

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

Creates a full Bing component earth colors array. The earth colors array will contain the specified water color and terrain colors (including interpolated values between the explicitly defined ones, as necessary).

Parameters

Parameter	Type	Default value	Description
waterColor	string	undefined	The desired water color, as a hex string with the format #hhhhhh.
terrainColors	object[]	undefined	An array of desired terrain colors at specific elevations. Elevations should be specified in feet and colors as hex strings with the format #hhhhhh.
minElevation	number	0	The minimum elevation to which to assign a color, in feet. Defaults to 0.
maxElevation	number	30000	The maximum elevation to which to assign a color, in feet. Defaults to 30000.
stepCount	number	61	The number of terrain color steps. Defaults to 61.

Returns

number[]

a full Bing component earth colors array.

---

hexaToRGBAColor()

static hexaToRGBAColor(hexColor): number

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

Converts an HTML hex color string to a numerical RGBA value, as R + G * 256 + B * 256^2 + A * 256^3.

Parameters

Parameter	Type	Description
hexColor	string	The hex color string to convert.

Returns

number

The numerical RGBA value equivalent of the specified hex color string, as R + G * 256 + B * 256^2 + A * 256^3.

---

hexaToRGBColor()

static hexaToRGBColor(hexColor): number

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

Converts an HTML hex color string to a numerical RGB value, as R + G * 256 + B * 256^2.

Parameters

Parameter	Type	Description
hexColor	string	The hex color string to convert.

Returns

number

The numerical RGB value equivalent of the specified hex color string, as R + G * 256 + B * 256^2.

---

rgbaColor()

static rgbaColor(r, g, b, a): number

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

Converts RGBA color components to a numerical RGBA value, as R + G * 256 + B * 256^2 + A * 256^3.

Parameters

Parameter	Type	Description
r	number	The red component, from 0 to 255.
g	number	The green component, from 0 to 255.
b	number	The blue component, from 0 to 255.
a	number	The alpha component, from 0 to 255.

Returns

number

The numerical RGBA value of the specified components, as R + G * 256 + B * 256^2 + A * 256^3.

---

rgbaToHexaColor()

static rgbaToHexaColor(rgba, poundPrefix): string

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

Converts a numerical RGBA value to an HTML hex color string.

Parameters

Parameter	Type	Default value	Description
rgba	number	undefined	The numerical RGBA value to convert, as R + G * 256 + B * 256^2 + A * 256^3.
poundPrefix	boolean	true	Whether to include the pound (#) prefix in the converted string. Defaults to true.

Returns

string

The HTML hex color string equivalent of the specified numerical RGBA value.

---

rgbColor()

static rgbColor(r, g, b): number

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

Converts RGB color components to a numerical RGB value, as R + G * 256 + B * 256^2.

Parameters

Parameter	Type	Description
r	number	The red component, from 0 to 255.
g	number	The green component, from 0 to 255.
b	number	The blue component, from 0 to 255.

Returns

number

The numerical RGB value of the specified components, as R + G * 256 + B * 256^2.

---

rgbToHexaColor()

static rgbToHexaColor(rgb, poundPrefix): string

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

Converts a numerical RGB value to an HTML hex color string.

Parameters

Parameter	Type	Default value	Description
rgb	number	undefined	The numerical RGB value to convert, as R + G * 256 + B * 256^2.
poundPrefix	boolean	true	Whether to include the pound (#) prefix in the converted string. Defaults to true.

Returns

string

The HTML hex color string equivalent of the specified numerical RGB value.