Skip to main content

Class: ProcMapFullFlightPathPlanRenderer

The full-route renderer for procedure preview flight plan paths. Renders all flight path vectors within flight plan legs, including transition vectors, with support for different styles for procedure and transition previews.

Hierarchy

  • AbstractFlightPathPlanRenderer<[isTransition: boolean]>

    ProcMapFullFlightPathPlanRenderer

Constructors

constructor

new ProcMapFullFlightPathPlanRenderer(renderOrder?, renderActiveLegLast?): ProcMapFullFlightPathPlanRenderer

Constructor.

Parameters

NameTypeDefault valueDescription
renderOrderFlightPathPlanRenderOrder'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.
renderActiveLegLastbooleantrueWhether to render the active leg last. Defaults to true.

Returns

ProcMapFullFlightPathPlanRenderer

Inherited from

AbstractFlightPathPlanRenderer<[isTransition: boolean]>.constructor

Defined in

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

Properties

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


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

NameTypeDescription
planFlightPlanThe flight plan to render.
startIndexundefined | numberThe global index of the first flight plan leg to render, inclusive. Defaults to 0.
endIndexundefined | numberThe global index of the last flight plan leg to render, inclusive. Defaults to plan.length - 1.
contextCanvasRenderingContext2DThe canvas 2D rendering context to which to render.
streamStackGeoProjectionPathStreamStackThe path stream stack to which to render.
...args[isTransition: boolean]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, isTransition): void

Parameters

NameType
legLegDefinition
planFlightPlan
activeLegundefined | LegDefinition
legIndexnumber
activeLegIndexnumber
contextCanvasRenderingContext2D
streamStackGeoProjectionPathStreamStack
isTransitionboolean

Returns

void

Inherit Doc

Overrides

AbstractFlightPathPlanRenderer.renderLeg

Defined in

src/garminsdk/components/map/flightplan/ProcMapFlightPathPlanRenderer.ts:26