Class: DefaultObsSuspDataProvider
A default implementation of ObsSuspDataProvider.
Implements
Constructors
constructor
• new DefaultObsSuspDataProvider(bus, options?): DefaultObsSuspDataProvider
Creates a new instance of DefaultObsSuspDataProvider.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
options? | Readonly<DefaultObsSuspDataProviderOptions> | Options with which to configure the data provider. |
Returns
Defined in
src/garminsdk/navigation/Obs.ts:84
Properties
isObsAvailable
• Readonly isObsAvailable: Subscribable<boolean>
Whether OBS mode can be activated.
Implementation of
ObsSuspDataProvider.isObsAvailable
Defined in
src/garminsdk/navigation/Obs.ts:67
mode
• Readonly mode: Subscribable<ObsSuspModes>
The current LNAV OBS/suspend mode.
Implementation of
Defined in
src/garminsdk/navigation/Obs.ts:50
obsCourse
• Readonly obsCourse: Subscribable<number>
The current magnetic OBS course, in degrees.
Implementation of
Defined in
src/garminsdk/navigation/Obs.ts:71
Methods
destroy
▸ destroy(): void
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
Defined in
src/garminsdk/navigation/Obs.ts:188
init
▸ init(paused?): void
Initializes this data provider. Once initialized, this data provider will continuously update its data until paused or destroyed.
Parameters
| Name | 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.
Defined in
src/garminsdk/navigation/Obs.ts:98
pause
▸ pause(): void
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.
Defined in
src/garminsdk/navigation/Obs.ts:163
resume
▸ resume(): void
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.
Defined in
src/garminsdk/navigation/Obs.ts:138