Class: MapFlightPlannerPlanDataProvider

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:26

A map flight plan layer data provider that provides a displayed flight plan from a flight planner.

Implements

• MapFlightPlanDataProvider

Constructors

Constructor

new MapFlightPlannerPlanDataProvider(bus, options): MapFlightPlannerPlanDataProvider

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:139

Creates a new instance of MapFlightPlannerPlanDataProvider.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
options	Readonly<MapFlightPlannerPlanDataProviderOptions>	Options with which to configure the data provider.

Returns

MapFlightPlannerPlanDataProvider

Constructor

new MapFlightPlannerPlanDataProvider(bus, flightPlanner): MapFlightPlannerPlanDataProvider

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:148

Creates a new instance of MapFlightPlannerPlanDataProvider.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
flightPlanner	FlightPlanner	The flight planner from which to retrieve displayed flight plans.

Returns

MapFlightPlannerPlanDataProvider

Properties

activeLateralLegIndex

readonly activeLateralLegIndex: Subscribable<number>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:41

A subscribable which provides the index of the active lateral leg of the displayed flight plan, or -1 if no such leg exists.

Implementation of

MapFlightPlanDataProvider.activeLateralLegIndex

---

lnavData

readonly lnavData: Subscribable<undefined | LNavTrackingState>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:58

A subscribable which provides LNAV data.

Implementation of

MapFlightPlanDataProvider.lnavData

---

obsCourse

readonly obsCourse: Subscribable<undefined | number>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:102

A subscribable which provides the current OBS course, or undefined if OBS is not active.

Implementation of

MapFlightPlanDataProvider.obsCourse

---

plan

readonly plan: Subscribable<null | FlightPlan>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:31

A subscribable which provides the flight plan to be displayed.

Implementation of

MapFlightPlanDataProvider.plan

---

planCalculated

readonly planCalculated: SubEvent<MapFlightPlannerPlanDataProvider, void>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:37

An event which notifies when the displayed plan has been calculated.

Implementation of

MapFlightPlanDataProvider.planCalculated

---

planModified

readonly planModified: SubEvent<MapFlightPlannerPlanDataProvider, void>

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

An event which notifies when the displayed plan has been modified.

Implementation of

MapFlightPlanDataProvider.planModified

---

vnavBocLegIndex

readonly vnavBocLegIndex: Subscribable<number>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:90

A subscribable which provides the index of the leg within which the VNAV bottom-of-climb point lies, or -1 if no such leg exists.

Implementation of

MapFlightPlanDataProvider.vnavBocLegIndex

---

vnavBodLegIndex

readonly vnavBodLegIndex: Subscribable<number>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:74

A subscribable which provides the index of the leg within which the VNAV bottom-of-descent point lies, or -1 if no such leg exists.

Implementation of

MapFlightPlanDataProvider.vnavBodLegIndex

---

vnavDistanceToToc

readonly vnavDistanceToToc: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:98

A subscribable which provides the distance along the flight path from the plane's current position to the next top-of-climb.

Implementation of

MapFlightPlanDataProvider.vnavDistanceToToc

---

vnavDistanceToTod

readonly vnavDistanceToTod: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:82

A subscribable which provides the distance along the flight path from the plane's current position to the next top-of-descent.

Implementation of

MapFlightPlanDataProvider.vnavDistanceToTod

---

vnavPathMode

readonly vnavPathMode: Subscribable<VNavPathMode>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:66

A subscribable which provides the currently active VNAV path mode.

Implementation of

MapFlightPlanDataProvider.vnavPathMode

---

vnavState

readonly vnavState: Subscribable<VNavState>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:62

A subscribable which provides the current VNAV state.

Implementation of

MapFlightPlanDataProvider.vnavState

---

vnavTocLegDistance

readonly vnavTocLegDistance: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:94

A subscribable which provides the distance along the flight path from the VNAV top-of-climb point to the end of the TOC leg.

Implementation of

MapFlightPlanDataProvider.vnavTocLegDistance

---

vnavTocLegIndex

readonly vnavTocLegIndex: Subscribable<number>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:86

A subscribable which provides the index of the leg within which the VNAV top-of-climb point lies, or -1 if no such leg exists.

Implementation of

MapFlightPlanDataProvider.vnavTocLegIndex

---

vnavTodLegDistance

readonly vnavTodLegDistance: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:78

A subscribable which provides the distance along the flight path from the VNAV top-of-descent point to the end of the TOD leg.

Implementation of

MapFlightPlanDataProvider.vnavTodLegDistance

---

vnavTodLegIndex

readonly vnavTodLegIndex: Subscribable<number>

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:70

A subscribable which provides the index of the leg within which the VNAV top-of-descent point lies, or -1 if no such leg exists.

Implementation of

MapFlightPlanDataProvider.vnavTodLegIndex

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:407

Destroys this data provider.

Returns

void

---

setPlanIndex()

setPlanIndex(index): void

Defined in: src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:331

Sets the index of the displayed plan.

Parameters

Parameter	Type	Description
index	number	The index of the displayed plan.

Returns

void

Throws

Error if this data provider has been destroyed.