WS_StopLocation.js

Summary
WS_StopLocation.js
Properties
ID{String} Gets or sets the stop ID.
IsViaPoint{Boolean} Gets or sets whether the stop is a via point or not.
SideOfStreetAdherence{Number} How strict to be in order to avoid the destination being on the opposite side of the street.
Constructor
ALKMaps.WS_StopLocationConstruct a new stop location object.
Functions
fromStopLocation
fromStopLocations

Properties

ID

{String} Gets or sets the stop ID.

IsViaPoint

{Boolean} Gets or sets whether the stop is a via point or not.

SideOfStreetAdherence

{Number} How strict to be in order to avoid the destination being on the opposite side of the street.

Available values

0Off.  Will not reroute according to the side of the street.
1Minimal.  Adds a cost of a quarter of a mile to ending up on the wrong side of the street.
2Moderate.  Adds a cost of half a mile to ending up on the wrong side of the street.
3Average.  Adds a cost of one mile to ending up on the wrong side of the street.
4Strict.  Adds a cost of five miles to ending up on the wrong side of the street.
5Adhere.  Adds a cost of 10 miles to ending up on the wrong side of the street.
6StronglyAdhere.  Adds a cost of 1,000 miles to ending up on the wrong side of the street.

Constructor

ALKMaps.WS_StopLocation

Construct a new stop location object.

Parameters (single argument)

params{Object} {ID: “”, IsViaPoint: true, Address: {}, Coords: {}, Label: “”}

Functions

fromStopLocation

ALKMaps.WS_StopLocation.fromStopLocation = function (stopLoc,
options)

Parameters

stopLoc{ALKMaps.StopLocation}

Returns

{ALKMaps.WS_StopLocation} New stop location object built from the passed-in object.

fromStopLocations

ALKMaps.WS_StopLocation.fromStopLocations = function (stopLocations,
options)

Parameters

stopLocations{Array(ALKMaps.StopLocation)}

Returns

{Array(ALKMaps.WS_Location)} An array of stop locations.

ALKMaps.WS_StopLocation.fromStopLocation = function (stopLoc,
options)
ALKMaps.WS_StopLocation.fromStopLocations = function (stopLocations,
options)
Instances of this class represent stop location.
Construct a new stop location object.
Construct a new location object.
Close