Skip to main content

Class: FlightPathRenderStyle

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:122

A vector line rendering style to apply to a flight path display on the map.

Constructors​

Constructor​

new FlightPathRenderStyle(isDisplayed): FlightPathRenderStyle

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:128

Creates an instance of a FlightPathRenderStyle.

Parameters​

ParameterTypeDefault valueDescription
isDisplayedbooleantrueWhether or not the path is displayed.

Returns​

FlightPathRenderStyle

Properties​

dash?​

optional dash: number[]

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:137

A dash-array configuration for the line, if any.

isDisplayed​

isDisplayed: boolean = true

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:128

Whether or not the path is displayed.

lineCap?​

optional lineCap: CanvasLineCap

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:146

The line cap style to use. Defaults to 'butt'.

outlineStyle?​

optional outlineStyle: string

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:143

The style of the outline. Defaults to 'black'.

outlineWidth?​

optional outlineWidth: number

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:140

The width of the outline, in pixels. Defaults to 0 pixels.

partsToRender?​

optional partsToRender: FlightPathLegRenderPart

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:149

An optional override of which parts to render for the leg.

style​

style: string = ''

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:134

The style string for the line.

width​

width: number = 2

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:131

The pixel width of the path line.

Default​

readonly static Default: FlightPathRenderStyle

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:152

The default rendering style.

Hidden​

readonly static Hidden: FlightPathRenderStyle

Defined in: src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:155

A style that does not display the path.