Class: MapSystemSharedFlightPlanLayer

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:114

A map layer that draws zero or more flight plans. The layer draws the flight paths of the flight plans to a shared canvas. Flight plan waypoints associated with the plans are registered with a waypoint renderer. Importantly however, the layer does not by itself display any rendered waypoints; the waypoint renderer must be set up to render the flight plan waypoints to a separate layer.

Extends

• MapLayer<MapSystemSharedFlightPlanLayerProps>

Constructors

Constructor

new MapSystemSharedFlightPlanLayer(props): MapSystemSharedFlightPlanLayer

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	MapSystemSharedFlightPlanLayerProps	The propertis of the component.

Returns

MapSystemSharedFlightPlanLayer

Inherited from

MapLayer.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

MapLayer.contextType

---

props

props: MapSystemSharedFlightPlanLayerProps & ComponentProps

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

The properties of the component.

Inherited from

MapLayer.props

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:206

Destroys this component.

Returns

void

Overrides

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

MapLayer.getContext

---

isFlightPlanVisible()

isFlightPlanVisible(planIndex): boolean

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:137

Gets whether a flight plan rendered by this layer is set to be visible. If this layer as a whole is not visible (as set by setVisible()), then none of the flight plans rendered by this layer will be visible, regardless of the value returned by this method.

Parameters

Parameter	Type	Description
planIndex	number	The index of the flight plan for which to get the visibility state.

Returns

boolean

Whether the specified flight plan is set to be visible, or false if the flight plan is not rendered by this layer.

---

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

MapLayer.isVisible

---

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

MapLayer.onAfterRender

---

onAttached()

onAttached(): void

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:154

This method is called when this layer is attached to its parent map component.

Returns

void

Overrides

MapLayer.onAttached

---

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

MapLayer.onBeforeRender

---

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

MapLayer.onDetached

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:161

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/MapLayer.ts:81

This method is called when this layer's parent map is put to sleep.

Returns

void

Inherited from

MapLayer.onSleep

---

onUpdated()

onUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:166

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

MapLayer.onUpdated

---

onVisibilityChanged()

onVisibilityChanged(isVisible): void

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

This method is called when this layer's visibility changes.

Parameters

Parameter	Type	Description
isVisible	boolean	Whether the layer is now visible.

Returns

void

Inherited from

MapLayer.onVisibilityChanged

---

onWake()

onWake(): void

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

This method is called when this layer's parent map is woken.

Returns

void

Inherited from

MapLayer.onWake

---

render()

render(): VNode

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:171

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapLayer.render

---

setFlightPlanVisible()

setFlightPlanVisible(planIndex, val): void

Defined in: src/sdk/components/mapsystem/layers/MapSystemSharedFlightPlanLayer.tsx:149

Sets the visibility of a flight plan rendered by this layer. If this layer as a whole is not visible (as set by setVisible()), then none of the flight plans rendered by this layer will be visible, regardless of the individual flight plan visibilities set by this method.

Parameters

Parameter	Type	Description
planIndex	number	The index of the flight plan for which to set visibility. Attempting to set the visibility of a plan that is not rendered by this layer will have no effect.
val	boolean	Whether the flight plan should be visible.

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

MapLayer.setVisible