Class: DefaultBaseFlightPathPlanRenderer

Defined in: src/garminsdk/components/map/flightplan/MapDefaultFlightPathPlanRenderer.ts:19

The default base-route flight plan renderer for Garmin maps. Only renders non-transition flight path vectors within flight plan legs.

Extends

• AbstractFlightPathPlanRenderer

Constructors

Constructor

new DefaultBaseFlightPathPlanRenderer(renderOrder, renderActiveLegLast): DefaultBaseFlightPathPlanRenderer

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

Constructor.

Parameters

Parameter	Type	Default value	Description
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.
renderActiveLegLast	boolean	true	Whether to render the active leg last. Defaults to true.

Returns

DefaultBaseFlightPathPlanRenderer

Inherited from

AbstractFlightPathPlanRenderer.constructor

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.

Inherited from

AbstractFlightPathPlanRenderer.renderActiveLegLast

---

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/garminsdk/components/map/flightplan/MapDefaultFlightPathPlanRenderer.ts:25

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