Class: WaypointInfoStore
A store for commonly used waypoint info.
Constructors
constructor
• new WaypointInfoStore(waypoint?, planePos?, options?): WaypointInfoStore
Constructor.
Parameters
| Name | Type | Description |
|---|---|---|
waypoint? | null | Waypoint | Subscribable<null | Waypoint> | A subscribable which provides this store's waypoint, or an initial value to set this store's waypoint. If not defined, this store's waypoint can still be set via its .waypoint property. |
planePos? | Subscribable<GeoPointInterface> | A subscribable which provides the current airplane position for this store. If not defined, then this store will not provide distance- or bearing-to-waypoint information. |
options? | Readonly<WaypointInfoStoreOptions> | Options with which to configure the store. |
Returns
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:96
Properties
city
• Readonly city: Subscribable<undefined | string>
The city associated with this store's current waypoint, or undefined if there is no such value.
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:53
facility
• Readonly facility: Subscribable<null | Facility>
The facility associated with this store's current waypoint.
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:31
name
• Readonly name: Subscribable<undefined | string>
The name of this store's current waypoint, or undefined if there is no such value.
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:41
region
• Readonly region: Subscribable<undefined | string>
The region of this store's current waypoint, or undefined if there is no such value.
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:50
waypoint
• Readonly waypoint: Subject<null | Waypoint>
This store's current waypoint.
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:27
Accessors
bearing
• get bearing(): Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>
The true bearing, in degrees, from the airplane to this store's current waypoint.
Returns
Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:71
distance
• get distance(): Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>
The distance from the airplane to this store's current waypoint.
Returns
Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:64
location
• get location(): Subscribable<GeoPointInterface>
The location of this store's current waypoint.
Returns
Subscribable<GeoPointInterface>
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:36
radial
• get radial(): Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>
The radial relative to true north, in degrees, from this store's current waypoint along which the airplane lies.
Returns
Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:78
Methods
destroy
▸ destroy(): void
Destroys this store.
Returns
void
Defined in
src/garminsdk/navigation/WaypointInfoStore.ts:230