Class: CustomWaypoint
Defined in: src/sdk/navigation/Waypoint.ts:65
A waypoint with custom defined lat/lon coordinates.
Extends
Constructors
Constructor
new CustomWaypoint(
lat,lon,uidPrefix):CustomWaypoint
Defined in: src/sdk/navigation/Waypoint.ts:75
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
lat | number | The latitude of this waypoint. |
lon | number | The longitude of this waypoint. |
uidPrefix | string | The prefix of this waypoint's UID. |
Returns
CustomWaypoint
Overrides
Constructor
new CustomWaypoint(
location,uid):CustomWaypoint
Defined in: src/sdk/navigation/Waypoint.ts:81
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
location | Subscribable<GeoPointInterface> | A subscribable which provides the location of this waypoint. |
uid | string | This waypoint's UID. |
Returns
CustomWaypoint
Overrides
AbstractWaypoint.constructor
Accessors
location
Get Signature
get location():
Subscribable<GeoPointInterface>
Defined in: src/sdk/navigation/Waypoint.ts:102
The geographic location of the waypoint.
Returns
Subscribable<GeoPointInterface>
The geographic location of the waypoint.
Overrides
type
Get Signature
get type():
string
Defined in: src/sdk/navigation/Waypoint.ts:112
The unique string type of this waypoint.
Returns
string
The unique string type of this waypoint.
Overrides
uid
Get Signature
get uid():
string
Defined in: src/sdk/navigation/Waypoint.ts:107
A unique string ID assigned to this waypoint.
Returns
string
A unique string ID assigned to this waypoint.
Overrides
Methods
equals()
equals(
other):boolean
Defined in: src/sdk/navigation/Waypoint.ts:57
Checks whether this waypoint and another are equal.
Parameters
| Parameter | Type | Description |
|---|---|---|
other | Waypoint | The other waypoint. |
Returns
boolean
whether this waypoint and the other are equal.