Class: DefaultNavStatusBoxDataProvider
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:17
A default implementation of NavStatusBoxDataProvider.
Implements
Constructors
Constructor
new DefaultNavStatusBoxDataProvider(
bus,fms,waypointAlertComputer,vnavDataProvider?):DefaultNavStatusBoxDataProvider
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:66
Creates a new instance of DefaultNavStatusBoxDataProvider.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
fms | Fms | The FMS. |
waypointAlertComputer | WaypointAlertComputer | The waypoint alert computer from which to source this provider's waypoint alert data. |
vnavDataProvider? | VNavDataProvider | The VNAV data provider from which to source this provider's vertical track alert data. If not defined, then vertical track alert data will not be provided. |
Returns
DefaultNavStatusBoxDataProvider
Properties
obsCourse
readonlyobsCourse:Subscribable<null|number>
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:38
The current active OBS course, in degrees, or null if OBS is inactive.
Implementation of
NavStatusBoxDataProvider.obsCourse
trackedLegs
readonlytrackedLegs:Subscribable<Readonly<NavStatusTrackedLegs>>
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:29
The current from, to, and next flight plan legs LNAV is tracking.
Implementation of
NavStatusBoxDataProvider.trackedLegs
verticalTrackAlert
readonlyverticalTrackAlert:ReadonlySubEvent<void,GarminVNavTrackAlertType>
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:47
An event that is fired when a vertical track alert is issued. The event data is the alert type.
Implementation of
NavStatusBoxDataProvider.verticalTrackAlert
waypointAlertState
readonlywaypointAlertState:Subscribable<Readonly<WaypointAlertStateEvent>>
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:41
The current waypoint alert state.
Implementation of
NavStatusBoxDataProvider.waypointAlertState
waypointAlertTime
readonlywaypointAlertTime:NumberUnitSubject<Duration,SimpleUnit<Duration>>
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:44
The time remaining for the current waypoint alert, or NaN if an alert is not active.
Implementation of
NavStatusBoxDataProvider.waypointAlertTime
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:242
Destroys this data provider. Once destroyed, this data provider will no longer update its provided data, and can no longer be paused or resumed.
Returns
void
init()
init(
paused):void
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:81
Initializes this data provider. Once initialized, this data provider will continuously update its data until paused or destroyed.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
paused | boolean | false | Whether to initialize this data provider as paused. If true, this data provider will provide an initial set of data but will not update the provided data until it is resumed. Defaults to false. |
Returns
void
Throws
Error if this data provider is dead.
pause()
pause():
void
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:219
Pauses this data provider. Once paused, this data provider will not update its data until it is resumed.
Returns
void
Throws
Error if this data provider is dead.
resume()
resume():
void
Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/DefaultNavStatusBoxDataProvider.ts:195
Resumes this data provider. Once resumed, this data provider will continuously update its data until paused or destroyed.
Returns
void
Throws
Error if this data provider is dead.