Skip to main content

Class: WaypointInfoStore

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:23

A store for commonly used waypoint info.

Constructors​

Constructor​

new WaypointInfoStore(waypoint?, planePos?, options?): WaypointInfoStore

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:96

Constructor.

Parameters​

ParameterTypeDescription
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​

WaypointInfoStore

Properties​

city​

readonly city: Subscribable<undefined | string>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:53

The city associated with this store's current waypoint, or undefined if there is no such value.

facility​

readonly facility: Subscribable<null | Facility>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:31

The facility associated with this store's current waypoint.

name​

readonly name: Subscribable<undefined | string>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:41

The name of this store's current waypoint, or undefined if there is no such value.

region​

readonly region: Subscribable<undefined | string>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:50

The region of this store's current waypoint, or undefined if there is no such value.

waypoint​

readonly waypoint: Subject<null | Waypoint>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:27

This store's current waypoint.

Accessors​

bearing​

Get Signature​

get bearing(): Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:71

The true bearing, in degrees, from the airplane to this store's current waypoint.

Returns​

Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>

distance​

Get Signature​

get distance(): Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:64

The distance from the airplane to this store's current waypoint.

Returns​

Subscribable<NumberUnitInterface<Distance, Unit<Distance>>>

location​

Get Signature​

get location(): Subscribable<GeoPointInterface>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:36

The location of this store's current waypoint.

Returns​

Subscribable<GeoPointInterface>

radial​

Get Signature​

get radial(): Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:78

The radial relative to true north, in degrees, from this store's current waypoint along which the airplane lies.

Returns​

Subscribable<NumberUnitInterface<"navangle", NavAngleUnit>>

Methods​

destroy()​

destroy(): void

Defined in: src/garminsdk/navigation/WaypointInfoStore.ts:230

Destroys this store.

Returns​

void