Skip to main content

Abstract Class: AbstractFlightPathPlanRenderer<Args>

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

Renders flight plan paths one leg at a time in either forward or reverse order. Optionally forces the rendering of the active flight plan leg to be last.

Extended by​

Type Parameters​

Type ParameterDefault type
Args extends any[][]

Constructors​

Constructor​

new AbstractFlightPathPlanRenderer<Args>(renderOrder, renderActiveLegLast): AbstractFlightPathPlanRenderer<Args>

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

Constructor.

Parameters​

ParameterTypeDefault 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​

AbstractFlightPathPlanRenderer<Args>

Properties​

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.


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.

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​

ParameterTypeDescription
planFlightPlanThe flight plan to render.
startIndexnumber | undefinedThe global index of the first flight plan leg to render, inclusive. Defaults to 0.
endIndexnumber | undefinedThe 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.
...argsArgsAdditional arguments.

Returns​

void


renderLeg()​

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

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

Renders a flight plan leg.

Parameters​

ParameterTypeDescription
legLegDefinitionThe flight plan leg to render.
planFlightPlanThe flight plan containing the leg to render.
activeLegLegDefinition | undefinedThe active leg in the flight plan.
legIndexnumberThe global index of the leg in its flight plan.
activeLegIndexnumberThe global index of the active flight plan leg.
contextCanvasRenderingContext2DThe canvas 2D rendering context to which to render.
streamStackGeoProjectionPathStreamStackThe path stream stack to which to render.
...argsArgs-

Returns​

void