Class: CustomWaypoint

A waypoint with custom defined lat/lon coordinates.

Hierarchy

• AbstractWaypoint

  ↳ CustomWaypoint

Constructors

constructor

• new CustomWaypoint(lat, lon, uidPrefix): CustomWaypoint

Constructor.

Parameters

Name	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

AbstractWaypoint.constructor

Defined in

src/sdk/navigation/Waypoint.ts:75

• new CustomWaypoint(location, uid): CustomWaypoint

Constructor.

Parameters

Name	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

Defined in

src/sdk/navigation/Waypoint.ts:81

Accessors

location

• get location(): Subscribable<GeoPointInterface>

The geographic location of the waypoint.

Returns

Subscribable<GeoPointInterface>

Overrides

AbstractWaypoint.location

Defined in

src/sdk/navigation/Waypoint.ts:102

---

type

• get type(): string

The unique string type of this waypoint.

Returns

string

Overrides

AbstractWaypoint.type

Defined in

src/sdk/navigation/Waypoint.ts:112

---

uid

• get uid(): string

A unique string ID assigned to this waypoint.

Returns

string

Overrides

AbstractWaypoint.uid

Defined in

src/sdk/navigation/Waypoint.ts:107

Methods

equals

▸ equals(other): boolean

Checks whether this waypoint and another are equal.

Parameters

Name	Type	Description
other	Waypoint	The other waypoint.

Returns

boolean

whether this waypoint and the other are equal.

Inherited from

AbstractWaypoint.equals

Defined in

src/sdk/navigation/Waypoint.ts:57