Skip to main content

Interface: MapBingLayerProps<M>

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:20

Component props for the MapComponent.

Extends​

Type Parameters​

Type Parameter
M

Properties​

bingDelay?​

optional bingDelay: number

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:28

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

bingId​

bingId: string

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:22

The unique ID to assign to this Bing map.

bingSkipUnbindOnDestroy?​

optional bingSkipUnbindOnDestroy: boolean

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:31

Whether to skip unbinding the layer's bound Bing instance when the layer is destroyed. Defaults to false.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

MapLayerProps.children

class?​

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/map/MapLayer.ts:25

The CSS class(es) to apply to the root of this layer.

Inherited from​

MapLayerProps.class

earthColors​

earthColors: SubscribableArray<number>

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:38

The earth colors for the layer's 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/map/layers/MapBingLayer.tsx:47

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

isoLines?​

optional isoLines: Subscribable<boolean>

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:76

A subscribable which provides whether or not the map isolines are visible.

mapProjection​

mapProjection: MapProjection

Defined in: src/sdk/components/map/MapLayer.ts:15

A map projection model.

Inherited from​

MapLayerProps.mapProjection

model​

model: MapModel<M>

Defined in: src/sdk/components/map/MapLayer.ts:12

A map model.

Inherited from​

MapLayerProps.model

opacity?​

optional opacity: number | Subscribable<number>

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:79

The opacity to apply to the layer. If not defined, then no specific opacity will be set.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

MapLayerProps.ref

reference​

reference: Subscribable<EBingReference>

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:52

A subscribable which provides the reference mode for the layer's Bing component.

updateFreq?​

optional updateFreq: Subscribable<number>

Defined in: src/sdk/components/map/MapLayer.ts:22

A subscribable which provides the maximum update frequency of the layer, in hertz. Note that the actual update frequency will not exceed the update frequency of the layer's parent map. If not defined, the frequency will default to that of the layer's parent map.

Inherited from​

MapLayerProps.updateFreq

wxrColors?​

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

Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:71

The weather radar colors for the layer's 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/map/layers/MapBingLayer.tsx:57

A subscribable which provides the weather radar mode for the layer's Bing component.