Class: WptInfoStore
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/WptInfo/WptInfoStore.ts:8
Wpt info store
Extends
Constructors
Constructor
new WptInfoStore(
waypoint?
,planePos?
,options?
):WptInfoStore
Defined in: garminsdk/navigation/WaypointInfoStore.ts:97
Constructor.
Parameters
Parameter | 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
WptInfoStore
Inherited from
Properties
city
readonly
city:Subscribable
<undefined
|string
>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:54
The city associated with this store's current waypoint, or undefined
if there is no such value.
Inherited from
facility
readonly
facility:Subscribable
<null
|Facility
>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:32
The facility associated with this store's current waypoint.
Inherited from
name
readonly
name:Subscribable
<undefined
|string
>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:42
The name of this store's current waypoint, or undefined
if there is no such value.
Inherited from
prompt
readonly
prompt:Subject
<string
>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/WptInfo/WptInfoStore.ts:9
region
readonly
region:Subscribable
<undefined
|string
>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:51
The region of this store's current waypoint, or undefined
if there is no such value.
Inherited from
waypoint
Defined in: garminsdk/navigation/WaypointInfoStore.ts:28
This store's current waypoint.
Inherited from
Accessors
bearing
Get Signature
get bearing():
Subscribable
<NumberUnitInterface
<"navangle"
,NavAngleUnit
>>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:72
The true bearing, in degrees, from the airplane to this store's current waypoint.
Returns
Subscribable
<NumberUnitInterface
<"navangle"
, NavAngleUnit
>>
Inherited from
distance
Get Signature
get distance():
Subscribable
<NumberUnitInterface
<Distance
,Unit
<Distance
>>>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:65
The distance from the airplane to this store's current waypoint.
Returns
Subscribable
<NumberUnitInterface
<Distance
, Unit
<Distance
>>>
Inherited from
location
Get Signature
get location():
Subscribable
<GeoPointInterface
>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:37
The location of this store's current waypoint.
Returns
Subscribable
<GeoPointInterface
>
Inherited from
matchedWaypoints
Get Signature
get matchedWaypoints(): readonly
FacilityWaypoint
<Facility
>[]
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/WptInfo/WptInfoStore.ts:14
An array of waypoints which have matched the input.
Returns
readonly FacilityWaypoint
<Facility
>[]
radial
Get Signature
get radial():
Subscribable
<NumberUnitInterface
<"navangle"
,NavAngleUnit
>>
Defined in: garminsdk/navigation/WaypointInfoStore.ts:79
The radial relative to true north, in degrees, from this store's current waypoint along which the airplane lies.
Returns
Subscribable
<NumberUnitInterface
<"navangle"
, NavAngleUnit
>>
Inherited from
Methods
destroy()
destroy():
void
Defined in: garminsdk/navigation/WaypointInfoStore.ts:218
Destroys this store.
Returns
void
Inherited from
setMatchedWaypoints()
setMatchedWaypoints(
waypoints
):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/WptInfo/WptInfoStore.ts:22
Set the list of matched waypoints.
Parameters
Parameter | Type | Description |
---|---|---|
waypoints | readonly FacilityWaypoint <Facility >[] | An array of matched waypoints. |
Returns
void