Class: MapBingLayer<M>
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:82
A FSComponent that display the MSFS Bing Map, weather radar, and 3D terrain.
Extends
Type Parameters
Type Parameter | Default type |
---|---|
M | any |
Constructors
Constructor
new MapBingLayer<
M
>(props
):MapBingLayer
<M
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | MapBingLayerProps | The propertis of the component. |
Returns
MapBingLayer
<M
>
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
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
props
props:
MapBingLayerProps
<M
> &ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
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
isVisible()
isVisible():
boolean
Defined in: src/sdk/components/map/MapLayer.ts:38
Checks whether this layer is visible.
Returns
boolean
whether this layer is visible.
Inherited from
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
onAttached()
onAttached():
void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:111
This method is called when this layer is attached to its parent map component.
Returns
void
Overrides
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
onDetached()
onDetached():
void
Defined in: src/sdk/components/map/MapLayer.ts:108
This method is called when this layer is detached from its parent map component.
Returns
void
Inherited from
onMapProjectionChanged()
onMapProjectionChanged(
mapProjection
,changeFlags
):void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:179
This method is called when the map projection changes.
Parameters
Parameter | Type | Description |
---|---|---|
mapProjection | MapProjection | this layer's map projection. |
changeFlags | number | The types of changes made to the projection. |
Returns
void
Overrides
MapLayer
.onMapProjectionChanged
onSleep()
onSleep():
void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:132
This method is called when this layer's parent map is put to sleep.
Returns
void
Overrides
onUpdated()
onUpdated(
time
,elapsed
):void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:198
This method is called once every map update cycle.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current time as a UNIX timestamp. |
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void
Overrides
onVisibilityChanged()
onVisibilityChanged(
isVisible
):void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:106
This method is called when this layer's visibility changes.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
Overrides
onWake()
onWake():
void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:127
This method is called when this layer's parent map is woken.
Returns
void
Overrides
render()
render():
VNode
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:245
Renders the component.
Returns
A JSX element to be rendered.
Overrides
resetImgSrc()
resetImgSrc():
void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:211
Resets the underlying Bing component's img src attribute.
Returns
void
setVisible()
setVisible(
val
):void
Defined in: src/sdk/components/map/MapLayer.ts:46
Sets this layer's visibility.
Parameters
Parameter | Type | Description |
---|---|---|
val | boolean | Whether this layer should be visible. |
Returns
void
Inherited from
updatePositionRadius()
protected
updatePositionRadius():void
Defined in: src/sdk/components/map/layers/MapBingLayer.tsx:218
Updates the Bing map center position and radius.
Returns
void