Class: FlightPlanDisplayBuilder

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:10

A class that builds a configuration for the display of flight plans on the map.

Extends

• WaypointDisplayBuilder

Constructors

Constructor

new FlightPlanDisplayBuilder(iconFactory, labelFactory, waypointRenderer, flightPlanRenderer, planIndex): FlightPlanDisplayBuilder

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:22

Creates an instance of the FlightPlanDisplayBuilder.

Parameters

Parameter	Type	Description
iconFactory	MapSystemIconFactory	The icon factory to use with this builder.
labelFactory	MapSystemLabelFactory	The label factory to use with this builder.
waypointRenderer	MapSystemWaypointsRenderer	The waypoint renderer to use with this builder.
flightPlanRenderer	MapSystemPlanRenderer	The flight plan renderer to use with this builder.
planIndex	number	The flight plan index to be displayed by this system.

Returns

FlightPlanDisplayBuilder

Overrides

WaypointDisplayBuilder.constructor

Properties

facilityWaypointCache

protected facilityWaypointCache: FacilityWaypointCache | undefined

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:15

Inherited from

WaypointDisplayBuilder.facilityWaypointCache

---

iconFactory

protected readonly iconFactory: MapSystemIconFactory

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:23

The icon factory to use with this builder.

Inherited from

WaypointDisplayBuilder.iconFactory

---

isCenterTarget

protected isCenterTarget: boolean = false

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:14

Inherited from

WaypointDisplayBuilder.isCenterTarget

---

labelFactory

protected readonly labelFactory: MapSystemLabelFactory

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:23

The label factory to use with this builder.

Inherited from

WaypointDisplayBuilder.labelFactory

---

planIndex

readonly planIndex: number

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:23

The flight plan index to be displayed by this system.

---

roleGroup

protected roleGroup: string = MapSystemWaypointRoles.FlightPlan

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:12

Overrides

WaypointDisplayBuilder.roleGroup

---

waypointRenderer

protected readonly waypointRenderer: MapSystemWaypointsRenderer

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:24

The waypoint renderer to use with this builder.

Inherited from

WaypointDisplayBuilder.waypointRenderer

Methods

addDefaultIcon()

addDefaultIcon<T>(role, config): this

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:52

Adds a default icon configuration to the waypoint display system, if no other configuration is found.

Type Parameters

Type Parameter
T extends Waypoint

Parameters

Parameter	Type	Description
role	string | number	The role to add this waypoint display config for.
config	(waypoint) => MapWaypointIcon<T>	The waypoint icon factory to add as a configuration.

Returns

this

The modified builder.

Inherited from

WaypointDisplayBuilder.addDefaultIcon

---

addDefaultLabel()

addDefaultLabel<T>(role, config): this

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:75

Adds a label configuration to the waypoint display system.

Type Parameters

Type Parameter
T extends Waypoint

Parameters

Parameter	Type	Description
role	string | number	The role to add this waypoint display config for.
config	(waypoint) => MapCullableLocationTextLabel	The waypoint label factory to add as a configuration.

Returns

this

The modified builder.

Inherited from

WaypointDisplayBuilder.addDefaultLabel

---

addIcon()

addIcon<T>(role, type, config): this

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:41

Adds a icon configuration to the waypoint display system.

Type Parameters

Type Parameter
T extends Waypoint

Parameters

Parameter	Type	Description
role	string | number	The role to add this waypoint display config for.
type	string	The type of waypoint to add an icon for.
config	(waypoint) => MapWaypointIcon<T>	The waypoint icon factory to add as a configuration.

Returns

this

The modified builder.

Inherited from

WaypointDisplayBuilder.addIcon

---

addLabel()

addLabel<T>(role, type, config): this

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:64

Adds a label configuration to the waypoint display system.

Type Parameters

Type Parameter
T extends Waypoint

Parameters

Parameter	Type	Description
role	string | number	The role to add this waypoint display config for.
type	string	The type of waypoint to add an label for.
config	(waypoint) => MapCullableLocationTextLabel	The waypoint label factory to add as a configuration.

Returns

this

The modified builder.

Inherited from

WaypointDisplayBuilder.addLabel

---

getIsCenterTarget()

getIsCenterTarget(): boolean

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

Gets if the waypoint search is using the map target with offset as the search center.

Returns

boolean

True if the search center is the map target, false if it is the map center.

Inherited from

WaypointDisplayBuilder.getIsCenterTarget

---

getRoleGroup()

getRoleGroup(): string

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:30

Gets the render role group used by this builder when registering a render role with the waypoint renderer.

Returns

string

The render role group used by this builder when registering a render role with the waypoint renderer.

Inherited from

WaypointDisplayBuilder.getRoleGroup

---

getRoleId()

getRoleId(role): number

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:117

Gets the ID of a role in the waypoint display system.

Parameters

Parameter	Type	Description
role	string	The name of the role to get the ID for.

Returns

number

The ID of the role.

Throws

An error if an invalid role name is supplied.

Inherited from

WaypointDisplayBuilder.getRoleId

---

getWaypointCache()

getWaypointCache(): FacilityWaypointCache | undefined

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:164

Gets the currently set facility waypoint cache.

Returns

FacilityWaypointCache | undefined

The currently set facility waypoint cache.

Inherited from

WaypointDisplayBuilder.getWaypointCache

---

registerRole()

registerRole(name): this

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:30

Registers a render role for use with the waypoint renderer. When the render role is registered, it will also be added to this builder's render role group (accessible via getRoleGroup()).

Parameters

Parameter	Type	Description
name	string	The name of the role to register.

Returns

this

The modified builder.

Overrides

WaypointDisplayBuilder.registerRole

---

withAnticipationTurns()

withAnticipationTurns(visible): this

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:62

Configures the flight plan flight path display to set visibility of leg-to-leg turn anticipation transitions.

Parameters

Parameter	Type	Description
visible	boolean | Subscribable<boolean>	Whether or not the leg-to-leg turn anticipation transitions will be visible.

Returns

this

The modified builder.

---

withLegPathStyles()

withLegPathStyles(handler): this

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:40

Configures the flight path display to use styles returned by the provided function.

Parameters

Parameter	Type	Description
handler	LegStyleHandler	The handler to use to return the required path rendering styles.

Returns

this

The modified builder.

---

withLegWaypointRoles()

withLegWaypointRoles(handler): this

Defined in: src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:51

Configures the flight plan waypoint display to use the roles returned by the provided function.

Parameters

Parameter	Type	Description
handler	LegWaypointHandler	The handler to use to return the required waypoint display roles.

Returns

this

The modified builder.

---

withSearchCenter()

withSearchCenter(center): this

Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:132

Configures the center for waypoint searches for this display.

Parameters

Parameter	Type	Description
center	"center" | "target"	If center, then waypoint searches will use the map center. If target, waypoint searches will use the map target with offset.

Returns

this

The modified builder.

Inherited from

WaypointDisplayBuilder.withSearchCenter

---

withWaypointCache()

withWaypointCache(cache): this

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

Configures the facility waypoint cache to use with the waypoint display.

Parameters

Parameter	Type	Description
cache	FacilityWaypointCache | undefined	The facility waypoint cache to use, or undefined to use the default.

Returns

this

The modified builder.

Inherited from

WaypointDisplayBuilder.withWaypointCache