Stop

AMD: require(["esri/rest/support/Stop"], (Stop) => { /* code goes here */ });
ESM: import Stop from "@arcgis/core/rest/support/Stop.js";
Class: esri/rest/support/Stop
Inheritance: Stop Accessor
Since: ArcGIS Maps SDK for JavaScript 4.23

A stop respresents the start, end, or midpoint of a route in RouteLayer or RouteParameters.

See also
Example
// Display the route name and overall distance and duration.
const routeLayer = new RouteLayer({
  portalItem: {
    id: "69569b47b1e445b8a42ec12feab41ce9"
  }
});
await routeLayer.load();

const locale = "en-US";
const formatDate = new Intl.DateTimeFormat(locale, {
  year: 'numeric',
  month: 'numeric',
  day: 'numeric',
  hour: 'numeric',
  minute: 'numeric',
  second: 'numeric',
  timeZone: "America/Los_Angeles"
});

 for (const stop of routeLayer.stops) {
   const { arriveTime, departTime, name, locationType } = stop;
   console.log(`Stop:           ${locationType} at ${name}`);
   console.log(`Arrival Time:   ${formatDate.format(arriveTime)}`);
   console.log(`Departure Time: ${formatDate.format(departTime)}`);
 }

 // Stop:           stop at Kenoak Pl, Pomona, California, 91768
 // Arrival Time:   12/7/2020, 3:58:50 PM
 // Departure Time: 12/7/2020, 3:58:50 PM
 // Stop:           stop at 173 E Arbeth St, Rialto, California, 92377
 // Arrival Time:   12/7/2020, 4:38:29 PM
 // Departure Time: 12/7/2020, 4:38:29 PM
 // etc

Constructors

Stop

Constructor
new Stop(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Date

The date and time value indicating the arrival time at the stop.

Stop
Number

The local time offset (in minutes) for the arrival time.

Stop
String

Specify the direction a vehicle may arrive at and depart from the stop.

Stop
String

The name of the class.

Accessor
Date

The date and time value indicating the departure time from the stop.

Stop
Number

The local time offset in minutes for the departure time.

Stop
Point

The point location of the stop.

Stop
StringPossible Values:"stop"|"waypoint"|"break"Stop
String

The name of the stop.

Stop
Number

If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify with this attribute.

Stop
String

Indicates the status of the point with respect to its location on the network and the outcome of the analysis.

Stop
Date

The latest time the route can visit the stop.

Stop
Date

The earliest time the route can visit the stop.

Stop
String For Stop the type is always "stop". Stop

Property Details

arriveTime

Property
arriveTime Date

The date and time value indicating the arrival time at the stop.

arriveTimeOffset

Property
arriveTimeOffset Number

The local time offset (in minutes) for the arrival time.

curbApproach

Property
curbApproach String

Specify the direction a vehicle may arrive at and depart from the stop.

Possible Values:"either-side-of-vehicle"|"right-side-of-vehicle"|"left-side-of-vehicle"|"no-u-turn"

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

departTime

Property
departTime Date

The date and time value indicating the departure time from the stop.

departTimeOffset

Property
departTimeOffset Number

The local time offset in minutes for the departure time.

geometry

Property
geometry Point

The point location of the stop.

locationType

Property
locationType String

Possible Values:"stop"|"waypoint"|"break"

name

Property
name String

The name of the stop. The name is used in the driving directions. If the name is not specified, a unique name prefixed with Location is automatically generated in the output stops, routes, and directions.

sequence

Property
sequence Number

If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify with this attribute. In a group of stops that have the same RouteName value, the sequence number should be greater than 0 but not greater than the total number of stops. Also, the sequence number should not be duplicated.

status

Property
status String

Indicates the status of the point with respect to its location on the network and the outcome of the analysis.

Possible Values:"ok"|"not-located"|"network-element-not-located"|"element-not-traversable"|"invalid-field-values"|"not-reached"|"time-window-violation"|"not-located-on-closest"

timeWindowEnd

Property
timeWindowEnd Date

The latest time the route can visit the stop. The values for this field are copied from the TimeWindowEnd field on the input stops.

timeWindowStart

Property
timeWindowStart Date

The earliest time the route can visit the stop. The values for this field are copied from the TimeWindowStart field on the input stops.

type

Property
type Stringreadonly

For Stop the type is always "stop".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
Stop

Creates a Stop from the parsed Graphic.

Stop
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

Stop
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Graphic

Creates a Graphic from the Stop instance.

Stop
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

Stop

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromGraphic

Method
fromGraphic(graphic){Stop}static
Since: ArcGIS Maps SDK for JavaScript 4.24 Stop since 4.23, fromGraphic added at 4.24.

Creates a Stop from the parsed Graphic. The method assumes that the graphic's attributes conform to the route layer item schema.

Parameter
graphic Graphic
optional

A Graphic instance.

Returns
Type Description
Stop A Stop instance.

fromJSON

Method
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toGraphic

Method
toGraphic(){Graphic}
Since: ArcGIS Maps SDK for JavaScript 4.24 Stop since 4.23, toGraphic added at 4.24.

Creates a Graphic from the Stop instance. The resulting graphic will have attributes that conform to the route layer item schema.

Returns
Type Description
Graphic A Graphic instance.

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.