Interface: MapBingLayerProps<M>
Component props for the MapComponent.
Type parameters
| Name |
|---|
M |
Hierarchy
↳
MapBingLayerProps
Properties
bingId
• bingId: string
The unique ID to assign to this Bing map.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:20
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | SubscribableSet<string>
The CSS class(es) to apply to the root of this layer.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:25
delay
• Optional delay: number
How long to delay binding the map in milliseconds. Defaults to zero milliseconds.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:70
earthColors
• earthColors: SubscribableArray<number>
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.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:27
earthColorsElevationRange
• Optional earthColorsElevationRange: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
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].
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:36
isoLines
• Optional isoLines: Subscribable<boolean>
A subscribable which provides whether or not the map isolines are visible.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:65
mapProjection
• mapProjection: MapProjection
A map projection model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:15
mode
• Optional mode: EBingMode
The mode to put the map in. Defaults to EBingMode.PLANE.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:73
model
• model: MapModel<M>
A map model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:12
opacity
• Optional opacity: Subscribable<number>
The opacity of Map Bing Layer as set by pilot. Default to 1.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:76
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
reference
• reference: Subscribable<EBingReference>
A subscribable which provides the reference mode for the layer's Bing component.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:41
updateFreq
• Optional updateFreq: Subscribable<number>
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
Defined in
src/sdk/components/map/MapLayer.ts:22
wxrColors
• Optional wxrColors: SubscribableArray<readonly [number, number]>
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.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:60
wxrMode
• Optional wxrMode: Subscribable<WxrMode>
A subscribable which provides the weather radar mode for the layer's Bing component.
Defined in
src/sdk/components/map/layers/MapBingLayer.tsx:46