Class: FlightPlanDisplayBuilder
A class that builds the configuration for the flight plan display.
Hierarchy
↳
FlightPlanDisplayBuilder
Constructors
constructor
• new FlightPlanDisplayBuilder(iconFactory, labelFactory, waypointRenderer, flightPlanRenderer, planIndex): FlightPlanDisplayBuilder
Creates an instance of the FlightPlanDisplayBuilder.
Parameters
| Name | 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
Overrides
WaypointDisplayBuilder.constructor
Defined in
src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:22
Properties
facilityWaypointCache
• Protected facilityWaypointCache: undefined | FacilityWaypointCache
Inherited from
WaypointDisplayBuilder.facilityWaypointCache
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:15
iconFactory
• Protected Readonly iconFactory: MapSystemIconFactory
The icon factory to use with this builder.
Inherited from
WaypointDisplayBuilder.iconFactory
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:23
isCenterTarget
• Protected isCenterTarget: boolean = false
Inherited from
WaypointDisplayBuilder.isCenterTarget
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:14
labelFactory
• Protected Readonly labelFactory: MapSystemLabelFactory
The label factory to use with this builder.
Inherited from
WaypointDisplayBuilder.labelFactory
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:23
planIndex
• Readonly planIndex: number
The flight plan index to be displayed by this system.
Defined in
src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:23
roleGroup
• Protected roleGroup: string = MapSystemWaypointRoles.FlightPlan
Overrides
WaypointDisplayBuilder.roleGroup
Defined in
src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:12
waypointRenderer
• Protected Readonly waypointRenderer: MapSystemWaypointsRenderer
The waypoint renderer to use with this builder.
Inherited from
WaypointDisplayBuilder.waypointRenderer
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:24
Methods
addDefaultIcon
▸ addDefaultIcon<T>(role, config): this
Adds a default icon configuration to the waypoint display system, if no other configuration is found.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | Type | Description |
|---|---|---|
role | string | number | The role to add this waypoint display config for. |
config | (waypoint: T) => MapWaypointIcon<T> | The waypoint icon factory to add as a configuration. |
Returns
this
The modified builder.
Inherited from
WaypointDisplayBuilder.addDefaultIcon
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:44
addDefaultLabel
▸ addDefaultLabel<T>(role, config): this
Adds a label configuration to the waypoint display system.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | Type | Description |
|---|---|---|
role | string | number | The role to add this waypoint display config for. |
config | (waypoint: T) => MapCullableLocationTextLabel | The waypoint label factory to add as a configuration. |
Returns
this
The modified builder.
Inherited from
WaypointDisplayBuilder.addDefaultLabel
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:67
addIcon
▸ addIcon<T>(role, type, config): this
Adds a icon configuration to the waypoint display system.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | 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: T) => MapWaypointIcon<T> | The waypoint icon factory to add as a configuration. |
Returns
this
The modified builder.
Inherited from
WaypointDisplayBuilder.addIcon
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:33
addLabel
▸ addLabel<T>(role, type, config): this
Adds a label configuration to the waypoint display system.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | 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: T) => MapCullableLocationTextLabel | The waypoint label factory to add as a configuration. |
Returns
this
The modified builder.
Inherited from
WaypointDisplayBuilder.addLabel
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:56
getIsCenterTarget
▸ getIsCenterTarget(): boolean
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
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:138
getRoleId
▸ getRoleId(role): number
Gets the ID of a role in the waypoint display system.
Parameters
| Name | 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
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:109
getWaypointCache
▸ getWaypointCache(): undefined | FacilityWaypointCache
Gets the currently set facility waypoint cache.
Returns
undefined | FacilityWaypointCache
The currently set facility waypoint cache.
Inherited from
WaypointDisplayBuilder.getWaypointCache
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:156
registerRole
▸ registerRole(name): this
Registers a waypoint display role for use with the flight plan rendering system.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | The name of the role to register. |
Returns
this
The modified builder.
Overrides
WaypointDisplayBuilder.registerRole
Defined in
src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:36
withAnticipationTurns
▸ withAnticipationTurns(visible): this
Configures the flight plan flight path display to set visibility of leg-to-leg turn anticipation transitions.
Parameters
| Name | Type | Description |
|---|---|---|
visible | boolean | Subscribable<boolean> | Whether or not the leg-to-leg turn anticipation transitions will be visible. |
Returns
this
The modified builder.
Defined in
src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:68
withLegPathStyles
▸ withLegPathStyles(handler): this
Configures the flight path display to use styles returned by the provided function.
Parameters
| Name | Type | Description |
|---|---|---|
handler | LegStyleHandler | The handler to use to return the required path rendering styles. |
Returns
this
The modified builder.
Defined in
src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:46
withLegWaypointRoles
▸ withLegWaypointRoles(handler): this
Configures the flight plan waypoint display to use the roles returned by the provided function.
Parameters
| Name | Type | Description |
|---|---|---|
handler | LegWaypointHandler | The handler to use to return the required waypoint display roles. |
Returns
this
The modified builder.
Defined in
src/sdk/components/mapsystem/FlightPlanDisplayBuilder.ts:57
withSearchCenter
▸ withSearchCenter(center): this
Configures the center for waypoint searches for this display.
Parameters
| Name | 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
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:124
withWaypointCache
▸ withWaypointCache(cache): this
Configures the facility waypoint cache to use with the waypoint display.
Parameters
| Name | Type | Description |
|---|---|---|
cache | undefined | FacilityWaypointCache | The facility waypoint cache to use, or undefined to use the default. |
Returns
this
The modified builder.
Inherited from
WaypointDisplayBuilder.withWaypointCache
Defined in
src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:147