Class: ProcedureTurnLegWaypointsRecord
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:241
A record for procedure turn (PI) legs. Maintains two waypoints, both located at the PI leg's origin fix. The first waypoint is a standard FacilityWaypoint which is never rendered in an active flight plan waypoint role. The second is a ProcedureTurnWaypoint with an ident string equal to the PI leg's given name and which can be rendered in an active flight plan waypoint role.
Extends
Constructors
Constructor
new ProcedureTurnLegWaypointsRecord(
leg
,waypointRenderer
,facLoader
,facWaypointCache
,inactiveRenderRole
,activeRenderRole
):ProcedureTurnLegWaypointsRecord
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:257
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
leg | LegDefinition | The flight plan leg associated with this record. |
waypointRenderer | MapWaypointRenderer | The renderer used to render this record's waypoints. |
facLoader | FacilityLoader | The facility loader used by this waypoint. |
facWaypointCache | FacilityWaypointCache | The facility waypoint cache used by this record. |
inactiveRenderRole | MapWaypointRenderRole | The role(s) under which the waypoint should be registered when it is part of an inactive leg. |
activeRenderRole | MapWaypointRenderRole | The role(s) under which the waypoint should be registered when it is part of an active leg. |
Returns
ProcedureTurnLegWaypointsRecord
Overrides
AbstractFlightPlanLegWaypointsRecord
.constructor
Properties
activeRenderRole
protected
readonly
activeRenderRole:MapWaypointRenderRole
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:51
The role(s) under which the waypoint should be registered when it is part of an active leg.
Inherited from
AbstractFlightPlanLegWaypointsRecord
.activeRenderRole
facLoader
protected
readonly
facLoader:FacilityLoader
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:49
The facility loader used by this waypoint.
Inherited from
AbstractFlightPlanLegWaypointsRecord
.facLoader
inactiveRenderRole
protected
readonly
inactiveRenderRole:MapWaypointRenderRole
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:50
The role(s) under which the waypoint should be registered when it is part of an inactive leg.
Inherited from
AbstractFlightPlanLegWaypointsRecord
.inactiveRenderRole
isActive
protected
isActive:boolean
=false
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:34
Inherited from
AbstractFlightPlanLegWaypointsRecord
.isActive
leg
readonly
leg:LegDefinition
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:47
The flight plan leg associated with this record.
Inherited from
AbstractFlightPlanLegWaypointsRecord
.leg
uid
protected
uid:string
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:33
Inherited from
AbstractFlightPlanLegWaypointsRecord
.uid
waypointRenderer
protected
readonly
waypointRenderer:MapWaypointRenderer
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:48
The renderer used to render this record's waypoints.
Inherited from
AbstractFlightPlanLegWaypointsRecord
.waypointRenderer
Methods
deregisterWaypoint()
protected
deregisterWaypoint(waypoint
,role
):void
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:75
Removes a registration for a waypoint from this record's waypoint renderer.
Parameters
Parameter | Type | Description |
---|---|---|
waypoint | Waypoint | A waypoint. |
role | MapWaypointRenderRole | The role(s) from which the waypoint should be deregistered. |
Returns
void
Inherited from
AbstractFlightPlanLegWaypointsRecord
.deregisterWaypoint
destroy()
destroy():
void
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:292
Destroys this record. Deregisters all this record's waypoints with this record's waypoint renderer.
Returns
void
Overrides
AbstractFlightPlanLegWaypointsRecord
.destroy
refresh()
refresh(
isActive
):Promise
<void
>
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:271
Refreshes this record's waypoints, keeping them up to date with this record's associated flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
isActive | boolean | Whether this record's leg is the active leg. |
Returns
Promise
<void
>
Overrides
AbstractFlightPlanLegWaypointsRecord
.refresh
registerWaypoint()
protected
registerWaypoint(waypoint
,role
):void
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:66
Registers a waypoint with this record's waypoint renderer.
Parameters
Parameter | Type | Description |
---|---|---|
waypoint | Waypoint | A waypoint. |
role | MapWaypointRenderRole | The role(s) under which the waypoint should be registered. |
Returns
void