Class: FixIcaoWaypointsRecord
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:84
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,airportFacilityDataFlags?):FixIcaoWaypointsRecord
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:103
Creates a new instance of FixIcaoWaypointsRecord.
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 record. |
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. |
airportFacilityDataFlags? | number | Bitflags describing the requested data to be loaded in airport facilities retrieved by the new record. This controls what data are available from the airport waypoints that the record registers with the waypoint renderer. Defaults to AirportFacilityDataFlags.All. |
Returns
FixIcaoWaypointsRecord
Overrides
AbstractFlightPlanLegWaypointsRecord.constructor
Properties
_waypoint
protected_waypoint:FacilityWaypoint<Facility> |null=null
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:85
activeRenderRole
protectedreadonlyactiveRenderRole:MapWaypointRenderRole
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:52
The role(s) under which the waypoint should be registered when it is part of an active leg.
Inherited from
AbstractFlightPlanLegWaypointsRecord.activeRenderRole
airportFacilityDataFlags
protectedreadonlyairportFacilityDataFlags:number
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:87
facLoader
protectedreadonlyfacLoader:FacilityLoader
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:50
The facility loader used by this record.
Inherited from
AbstractFlightPlanLegWaypointsRecord.facLoader
facWaypointCache
protectedreadonlyfacWaypointCache:FacilityWaypointCache
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:107
The facility waypoint cache used by this record.
inactiveRenderRole
protectedreadonlyinactiveRenderRole: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 inactive leg.
Inherited from
AbstractFlightPlanLegWaypointsRecord.inactiveRenderRole
isActive
protectedisActive:boolean=false
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:35
Inherited from
AbstractFlightPlanLegWaypointsRecord.isActive
leg
readonlyleg:LegDefinition
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:48
The flight plan leg associated with this record.
Inherited from
AbstractFlightPlanLegWaypointsRecord.leg
uid
protecteduid:string
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:34
Inherited from
AbstractFlightPlanLegWaypointsRecord.uid
waypointRenderer
protectedreadonlywaypointRenderer:MapWaypointRenderer
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:49
The renderer used to render this record's waypoints.
Inherited from
AbstractFlightPlanLegWaypointsRecord.waypointRenderer
Accessors
waypoint
Get Signature
get waypoint():
FacilityWaypoint<Facility> |null
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:121
This record's waypoint.
Returns
FacilityWaypoint<Facility> | null
Methods
deregisterWaypoint()
protectedderegisterWaypoint(waypoint,role):void
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:76
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:168
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:126
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()
protectedregisterWaypoint(waypoint,role):void
Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:67
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