Class: MapFlightPlannerPlanDataProvider
A map flight plan layer data provider that provides a displayed flight plan from a flight planner.
Implements
Constructors
constructor
• new MapFlightPlannerPlanDataProvider(bus, options): MapFlightPlannerPlanDataProvider
Creates a new instance of MapFlightPlannerPlanDataProvider.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
options | Readonly<MapFlightPlannerPlanDataProviderOptions> | Options with which to configure the data provider. |
Returns
MapFlightPlannerPlanDataProvider
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:139
• new MapFlightPlannerPlanDataProvider(bus, flightPlanner): MapFlightPlannerPlanDataProvider
Creates a new instance of MapFlightPlannerPlanDataProvider.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
flightPlanner | FlightPlanner<any> | The flight planner from which to retrieve displayed flight plans. |
Returns
MapFlightPlannerPlanDataProvider
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:148
Properties
activeLateralLegIndex
• Readonly activeLateralLegIndex: Subscribable<number>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:41
lnavData
• Readonly lnavData: Subscribable<undefined | LNavTrackingState>
A subscribable which provides LNAV data.
Implementation of
MapFlightPlanDataProvider.lnavData
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:58
obsCourse
• Readonly obsCourse: Subscribable<undefined | number>
A subscribable which provides the current OBS course, or undefined if OBS is not active.
Implementation of
MapFlightPlanDataProvider.obsCourse
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:102
plan
• Readonly plan: Subscribable<null | FlightPlan>
A subscribable which provides the flight plan to be displayed.
Implementation of
MapFlightPlanDataProvider.plan
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:31
planCalculated
• Readonly planCalculated: SubEvent<MapFlightPlannerPlanDataProvider, void>
An event which notifies when the displayed plan has been calculated.
Implementation of
MapFlightPlanDataProvider.planCalculated
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:37
planModified
• Readonly planModified: SubEvent<MapFlightPlannerPlanDataProvider, void>
An event which notifies when the displayed plan has been modified.
Implementation of
MapFlightPlanDataProvider.planModified
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:34
vnavBocLegIndex
• Readonly vnavBocLegIndex: Subscribable<number>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:90
vnavBodLegIndex
• Readonly vnavBodLegIndex: Subscribable<number>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:74
vnavDistanceToToc
• Readonly vnavDistanceToToc: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:98
vnavDistanceToTod
• Readonly vnavDistanceToTod: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:82
vnavPathMode
• Readonly vnavPathMode: Subscribable<VNavPathMode>
A subscribable which provides the currently active VNAV path mode.
Implementation of
MapFlightPlanDataProvider.vnavPathMode
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:66
vnavState
• Readonly vnavState: Subscribable<VNavState>
A subscribable which provides the current VNAV state.
Implementation of
MapFlightPlanDataProvider.vnavState
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:62
vnavTocLegDistance
• Readonly vnavTocLegDistance: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:94
vnavTocLegIndex
• Readonly vnavTocLegIndex: Subscribable<number>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:86
vnavTodLegDistance
• Readonly vnavTodLegDistance: Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:78
vnavTodLegIndex
• Readonly vnavTodLegIndex: Subscribable<number>
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
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:70
Methods
destroy
▸ destroy(): void
Destroys this data provider.
Returns
void
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:407
setPlanIndex
▸ setPlanIndex(index): void
Sets the index of the displayed plan.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the displayed plan. |
Returns
void
Throws
Error if this data provider has been destroyed.
Defined in
src/garminsdk/components/map/flightplan/MapFlightPlannerPlanDataProvider.ts:331