Class: FixIcaoWaypointsRecord
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:83
A record with a single waypoint based on its flight plan leg's fixIcao property.
Extends
Constructors
Constructor
new FixIcaoWaypointsRecord(
leg
,waypointRenderer
,facLoader
,facWaypointCache
,inactiveRenderRole
,activeRenderRole
):FixIcaoWaypointsRecord
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:97
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
FixIcaoWaypointsRecord
Overrides
AbstractFlightPlanLegWaypointsRecord
.constructor
Properties
_waypoint
protected
_waypoint:null
|FacilityWaypoint
<Facility
> =null
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:84
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
facWaypointCache
protected
readonly
facWaypointCache:FacilityWaypointCache
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:101
The facility waypoint cache used by this record.
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
Accessors
waypoint
Get Signature
get waypoint():
null
|FacilityWaypoint
<Facility
>
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:112
This record's waypoint.
Returns
null
| FacilityWaypoint
<Facility
>
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:157
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:117
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