require(["esri/rest/support/Stop"], (Stop) => { /* code goes here */ });
import Stop from "@arcgis/core/rest/support/Stop.js";
esri/rest/support/Stop
A stop respresents the start, end, or midpoint of a route in RouteLayer or RouteParameters.
- See also
// 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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The date and time value indicating the arrival time at the stop. | Stop | ||
The local time offset (in minutes) for the arrival time. | Stop | ||
Specify the direction a vehicle may arrive at and depart from the stop. | Stop | ||
The name of the class. | Accessor | ||
The date and time value indicating the departure time from the stop. | Stop | ||
The local time offset in minutes for the departure time. | Stop | ||
The point location of the stop. | Stop | ||
Possible Values:"stop"|"waypoint"|"break" | Stop | ||
The name of the stop. | Stop | ||
The template for displaying content in a Popup when the graphic is selected. | Stop | ||
If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify with this attribute. | Stop | ||
Indicates the status of the point with respect to its location on the network and the outcome of the analysis. | Stop | ||
The latest time the route can visit the stop. | Stop | ||
The earliest time the route can visit the stop. | Stop | ||
For Stop the type is always "stop". | Stop |
Property Details
-
arriveTime
arriveTime Date
-
The date and time value indicating the arrival time at the stop.
-
arriveTimeOffset
arriveTimeOffset Number
-
The local time offset (in minutes) for the arrival time.
-
curbApproach
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"
-
departTime
departTime Date
-
The date and time value indicating the departure time from the stop.
-
departTimeOffset
departTimeOffset Number
-
The local time offset in minutes for the departure time.
-
geometry
geometry Point
-
The point location of the stop.
-
locationType
locationType String
-
Possible Values:"stop" |"waypoint" |"break"
-
name
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.
-
popupTemplate
popupTemplate PopupTemplateautocast
Since: ArcGIS Maps SDK for JavaScript 4.30Stop since 4.23, popupTemplate added at 4.30. -
The template for displaying content in a Popup when the graphic is selected.
-
sequence
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
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
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
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.
Method Overview
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 new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Stop | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Stop | |||
Converts an instance of this class to its ArcGIS portal JSON representation. | Stop |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
fromGraphic(graphic){Stop}static
Since: ArcGIS Maps SDK for JavaScript 4.24Stop 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.
Parametergraphic GraphicoptionalA Graphic instance.
ReturnsType Description Stop A Stop instance.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toGraphic
toGraphic(){Graphic}
Since: ArcGIS Maps SDK for JavaScript 4.24Stop 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.
ReturnsType Description Graphic A Graphic instance.
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.