Skip to main content

Class: CustomWaypoint

Defined in: src/sdk/navigation/Waypoint.ts:67

A waypoint with custom defined lat/lon coordinates.

Extends

Extended by

Constructors

Constructor

new CustomWaypoint(lat, lon, uidPrefix): CustomWaypoint

Defined in: src/sdk/navigation/Waypoint.ts:77

Constructor.

Parameters

ParameterTypeDescription
latnumberThe latitude of this waypoint.
lonnumberThe longitude of this waypoint.
uidPrefixstringThe prefix of this waypoint's UID.

Returns

CustomWaypoint

Overrides

AbstractWaypoint.constructor

Constructor

new CustomWaypoint(location, uid): CustomWaypoint

Defined in: src/sdk/navigation/Waypoint.ts:83

Constructor.

Parameters

ParameterTypeDescription
locationSubscribable<GeoPointInterface>A subscribable which provides the location of this waypoint.
uidstringThis waypoint's UID.

Returns

CustomWaypoint

Overrides

AbstractWaypoint.constructor

Accessors

location

Get Signature

get location(): Subscribable<GeoPointInterface>

Defined in: src/sdk/navigation/Waypoint.ts:104

The geographic location of the waypoint.

Returns

Subscribable<GeoPointInterface>

The geographic location of the waypoint.

Overrides

AbstractWaypoint.location


type

Get Signature

get type(): string

Defined in: src/sdk/navigation/Waypoint.ts:114

The unique string type of this waypoint.

Returns

string

The unique string type of this waypoint.

Overrides

AbstractWaypoint.type


uid

Get Signature

get uid(): string

Defined in: src/sdk/navigation/Waypoint.ts:109

A unique string ID assigned to this waypoint.

Returns

string

A unique string ID assigned to this waypoint.

Overrides

AbstractWaypoint.uid

Methods

equals()

equals(other): boolean

Defined in: src/sdk/navigation/Waypoint.ts:59

Checks whether this waypoint and another are equal.

Parameters

ParameterTypeDescription
otherWaypointThe other waypoint.

Returns

boolean

whether this waypoint and the other are equal.

Inherited from

AbstractWaypoint.equals