Class: ProcedureTurnLegWaypointsRecord
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.
Hierarchy
AbstractFlightPlanLegWaypointsRecord↳
ProcedureTurnLegWaypointsRecord
Constructors
constructor
• new ProcedureTurnLegWaypointsRecord(leg, waypointRenderer, facLoader, facWaypointCache, inactiveRenderRole, activeRenderRole): ProcedureTurnLegWaypointsRecord
Constructor.
Parameters
| Name | 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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:257
Properties
activeRenderRole
• Protected Readonly activeRenderRole: MapWaypointRenderRole
The role(s) under which the waypoint should be registered when it is part of an active leg.
Inherited from
AbstractFlightPlanLegWaypointsRecord.activeRenderRole
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:51
facLoader
• Protected Readonly facLoader: FacilityLoader
The facility loader used by this waypoint.
Inherited from
AbstractFlightPlanLegWaypointsRecord.facLoader
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:49
inactiveRenderRole
• Protected Readonly inactiveRenderRole: MapWaypointRenderRole
The role(s) under which the waypoint should be registered when it is part of an inactive leg.
Inherited from
AbstractFlightPlanLegWaypointsRecord.inactiveRenderRole
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:50
isActive
• Protected isActive: boolean = false
Inherited from
AbstractFlightPlanLegWaypointsRecord.isActive
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:34
leg
• Readonly leg: LegDefinition
The flight plan leg associated with this record.
Inherited from
AbstractFlightPlanLegWaypointsRecord.leg
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:47
uid
• Protected uid: string
Inherited from
AbstractFlightPlanLegWaypointsRecord.uid
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:33
waypointRenderer
• Protected Readonly waypointRenderer: MapWaypointRenderer
The renderer used to render this record's waypoints.
Inherited from
AbstractFlightPlanLegWaypointsRecord.waypointRenderer
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:48
Methods
deregisterWaypoint
▸ deregisterWaypoint(waypoint, role): void
Removes a registration for a waypoint from this record's waypoint renderer.
Parameters
| Name | Type | Description |
|---|---|---|
waypoint | Waypoint | A waypoint. |
role | MapWaypointRenderRole | The role(s) from which the waypoint should be deregistered. |
Returns
void
Inherited from
AbstractFlightPlanLegWaypointsRecord.deregisterWaypoint
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:75
destroy
▸ destroy(): void
Destroys this record. Deregisters all this record's waypoints with this record's waypoint renderer.
Returns
void
Overrides
AbstractFlightPlanLegWaypointsRecord.destroy
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:292
refresh
▸ refresh(isActive): Promise<void>
Refreshes this record's waypoints, keeping them up to date with this record's associated flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
isActive | boolean | Whether this record's leg is the active leg. |
Returns
Promise<void>
Overrides
AbstractFlightPlanLegWaypointsRecord.refresh
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:271
registerWaypoint
▸ registerWaypoint(waypoint, role): void
Registers a waypoint with this record's waypoint renderer.
Parameters
| Name | Type | Description |
|---|---|---|
waypoint | Waypoint | A waypoint. |
role | MapWaypointRenderRole | The role(s) under which the waypoint should be registered. |
Returns
void
Inherited from
AbstractFlightPlanLegWaypointsRecord.registerWaypoint
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:66