Class: FlightPathRenderStyle
A vector line rendering style to apply to a flight path display on the map.
Constructors
constructor
• new FlightPathRenderStyle(isDisplayed?): FlightPathRenderStyle
Creates an instance of a FlightPathRenderStyle.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
isDisplayed | boolean | true | Whether or not the path is displayed. |
Returns
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:121
Properties
dash
• Optional dash: number[]
A dash-array configuration for the line, if any.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:130
isDisplayed
• isDisplayed: boolean = true
Whether or not the path is displayed.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:121
lineCap
• Optional lineCap: CanvasLineCap
The line cap style to use. Defaults to 'butt'.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:139
outlineStyle
• Optional outlineStyle: string
The style of the outline. Defaults to 'black'.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:136
outlineWidth
• Optional outlineWidth: number
The width of the outline, in pixels. Defaults to 0 pixels.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:133
partsToRender
• Optional partsToRender: FlightPathLegRenderPart
An optional override of which parts to render for the leg.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:142
style
• style: string = ''
The style string for the line.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:127
width
• width: number = 2
The pixel width of the path line.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:124
Default
▪ Static Readonly Default: FlightPathRenderStyle
The default rendering style.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:145
Hidden
▪ Static Readonly Hidden: FlightPathRenderStyle
A style that does not display the path.
Defined in
src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:148