Class: MapSystemPlanRenderer

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:29

A map flight plan renderer that can be supplied styling from the outside.

Extends

• AbstractFlightPathPlanRenderer

Constructors

Constructor

new MapSystemPlanRenderer(defaultRoleId, renderOrder?, renderActiveLegLast?): MapSystemPlanRenderer

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:38

Creates an instance of the MapSystemPlanRenderer.

Parameters

Parameter	Type	Description
defaultRoleId	number	The default role ID to render the plan waypoints under.
renderOrder?	FlightPathPlanRenderOrder	The order which this renderer renders the flight plan legs. Forward order renders the legs in a first-to-last fashion. Reverse order renders the legs in a last-to-first fashion. Defaults to forward.
renderActiveLegLast?	boolean	Whether to render the active leg last. Defaults to true.

Returns

MapSystemPlanRenderer

Overrides

AbstractFlightPathPlanRenderer.constructor

Properties

defaultRoleId

defaultRoleId: number

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:38

The default role ID to render the plan waypoints under.

---

legRenderer

protected readonly legRenderer: MapSystemLegRenderer<any[]>

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:42

---

legStyleHandlers

readonly legStyleHandlers: Map<number, LegStyleHandler>

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:48

A handler that returns a leg rendering style for a given set of leg data.

Returns

A leg rendering style.

---

legWaypointHandlers

readonly legWaypointHandlers: Map<number, LegWaypointHandler>

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:54

A handler that returns whether or not a leg waypoint should be displayed.

Returns

Whether or not the leg should be displayed.

---

renderActiveLegLast

protected readonly renderActiveLegLast: boolean = true

Defined in: src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:20

Whether to render the active leg last. Defaults to true.

Inherited from

AbstractFlightPathPlanRenderer.renderActiveLegLast

---

renderEgress

renderEgress: Subscribable<boolean>

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:60

Whether or not to render flight path egress turns.

---

renderIngress

renderIngress: Subscribable<boolean>

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:57

Whether or not to render flight path ingress turns.

---

renderOrder

protected readonly renderOrder: FlightPathPlanRenderOrder = 'forward'

Defined in: src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:20

The order which this renderer renders the flight plan legs. Forward order renders the legs in a first-to-last fashion. Reverse order renders the legs in a last-to-first fashion. Defaults to forward.

Inherited from

AbstractFlightPathPlanRenderer.renderOrder

Methods

render()

render(plan, startIndex, endIndex, context, streamStack, ...args): void

Defined in: src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:32

Renders a flight plan path to a canvas.

Parameters

Parameter	Type	Description
plan	FlightPlan	The flight plan to render.
startIndex	number | undefined	The global index of the first flight plan leg to render, inclusive. Defaults to 0.
endIndex	number | undefined	The global index of the last flight plan leg to render, inclusive. Defaults to plan.length - 1.
context	CanvasRenderingContext2D	The canvas 2D rendering context to which to render.
streamStack	GeoProjectionPathStreamStack	The path stream stack to which to render.
...args	[]	Additional arguments.

Returns

void

Inherited from

AbstractFlightPathPlanRenderer.render

---

renderLeg()

protected renderLeg(leg, plan, activeLeg, legIndex, activeLegIndex, context, streamStack): void

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:63

Renders a flight plan leg.

Parameters

Parameter	Type	Description
leg	LegDefinition	The flight plan leg to render.
plan	FlightPlan	The flight plan containing the leg to render.
activeLeg	LegDefinition | undefined	The active leg in the flight plan.
legIndex	number	The global index of the leg in its flight plan.
activeLegIndex	number	The global index of the active flight plan leg.
context	CanvasRenderingContext2D	The canvas 2D rendering context to which to render.
streamStack	GeoProjectionPathStreamStack	The path stream stack to which to render.

Returns

void

Overrides

AbstractFlightPathPlanRenderer.renderLeg