Skip to main content

Abstract Class: AbstractFlightPlanLegWaypointsRecord

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:30

An abstract implementation of FlightPlanLegWaypointsRecord.

Extended by

Implements

Constructors

Constructor

new AbstractFlightPlanLegWaypointsRecord(leg, waypointRenderer, facLoader, inactiveRenderRole, activeRenderRole): AbstractFlightPlanLegWaypointsRecord

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:46

Constructor.

Parameters

ParameterTypeDescription
legLegDefinitionThe flight plan leg associated with this record.
waypointRendererMapWaypointRendererThe renderer used to render this record's waypoints.
facLoaderFacilityLoaderThe facility loader used by this waypoint.
inactiveRenderRoleMapWaypointRenderRoleThe role(s) under which the waypoint should be registered when it is part of an inactive leg.
activeRenderRoleMapWaypointRenderRoleThe role(s) under which the waypoint should be registered when it is part of an active leg.

Returns

AbstractFlightPlanLegWaypointsRecord

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.


facLoader

protected readonly facLoader: FacilityLoader

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:49

The facility loader used by this waypoint.


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.


isActive

protected isActive: boolean = false

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:34


leg

readonly leg: LegDefinition

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:47

The flight plan leg associated with this record.

Implementation of

FlightPlanLegWaypointsRecord.leg


uid

protected uid: string

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:33


waypointRenderer

protected readonly waypointRenderer: MapWaypointRenderer

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:48

The renderer used to render this record's waypoints.

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

ParameterTypeDescription
waypointWaypointA waypoint.
roleMapWaypointRenderRoleThe role(s) from which the waypoint should be deregistered.

Returns

void


destroy()

abstract destroy(): void

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:59

Destroys this record. Deregisters all this record's waypoints with this record's waypoint renderer.

Returns

void

Implementation of

FlightPlanLegWaypointsRecord.destroy


refresh()

abstract refresh(isActive): Promise<void>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlanWaypointRecord.ts:56

Refreshes this record's waypoints, keeping them up to date with this record's associated flight plan leg.

Parameters

ParameterTypeDescription
isActivebooleanWhether this record's leg is the active leg.

Returns

Promise<void>

Implementation of

FlightPlanLegWaypointsRecord.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

ParameterTypeDescription
waypointWaypointA waypoint.
roleMapWaypointRenderRoleThe role(s) under which the waypoint should be registered.

Returns

void