Class: MapSystemPlanRenderer

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

Hierarchy

• AbstractFlightPathPlanRenderer

  ↳ MapSystemPlanRenderer

Constructors

constructor

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

Creates an instance of the MapSystemPlanRenderer.

Parameters

Name	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

Defined in

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

Properties

defaultRoleId

• defaultRoleId: number

The default role ID to render the plan waypoints under.

Defined in

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

---

legRenderer

• Protected Readonly legRenderer: MapSystemLegRenderer

Defined in

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

---

legStyleHandlers

• Readonly legStyleHandlers: Map<number, LegStyleHandler>

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

Defined in

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

---

legWaypointHandlers

• Readonly legWaypointHandlers: Map<number, LegWaypointHandler>

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

Defined in

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

---

renderActiveLegLast

• Protected Readonly renderActiveLegLast: boolean = true

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

Inherited from

AbstractFlightPathPlanRenderer.renderActiveLegLast

Defined in

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

---

renderEgress

• renderEgress: Subscribable<boolean>

Whether or not to render flight path egress turns.

Defined in

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

---

renderIngress

• renderIngress: Subscribable<boolean>

Whether or not to render flight path ingress turns.

Defined in

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

---

renderOrder

• Protected Readonly renderOrder: FlightPathPlanRenderOrder = 'forward'

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

Defined in

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

Methods

render

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

Renders a flight plan path to a canvas.

Parameters

Name	Type	Description
plan	FlightPlan	The flight plan to render.
startIndex	undefined | number	The global index of the first flight plan leg to render, inclusive. Defaults to 0.
endIndex	undefined | number	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

Defined in

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

---

renderLeg

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

Renders a flight plan leg.

Parameters

Name	Type	Description
leg	LegDefinition	The flight plan leg to render.
plan	FlightPlan	The flight plan containing the leg to render.
activeLeg	undefined | LegDefinition	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

Defined in

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