Class: DefaultBaseFlightPathPlanRenderer
Defined in: src/garminsdk/components/map/flightplan/MapDefaultFlightPathPlanRenderer.ts:18
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
protectedreadonlyrenderActiveLegLast: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
protectedreadonlyrenderOrder: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 | 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
renderLeg()
protectedrenderLeg(leg,plan,activeLeg,legIndex,activeLegIndex,context,streamStack):void
Defined in: src/garminsdk/components/map/flightplan/MapDefaultFlightPathPlanRenderer.ts:24
Parameters
| Parameter | Type |
|---|---|
leg | LegDefinition |
plan | FlightPlan |
activeLeg | undefined | LegDefinition |
legIndex | number |
activeLegIndex | number |
context | CanvasRenderingContext2D |
streamStack | GeoProjectionPathStreamStack |
Returns
void
Inherit Doc
Overrides
AbstractFlightPathPlanRenderer.renderLeg