A RouteInfo contains information about a solved route including the routes geometry and overall distance and time.
- 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 formatMinutes = new Intl.NumberFormat(locale, {
minimumFractionDigits: 1,
maximumFractionDigits: 1
});
const formatDistance = new Intl.NumberFormat(locale, {
minimumFractionDigits: 0,
maximumFractionDigits: 0
});
const formatDate = new Intl.DateTimeFormat(locale, {
year: 'numeric',
month: 'numeric',
day: 'numeric',
hour: 'numeric',
minute: 'numeric',
second: 'numeric',
timeZone: "America/Los_Angeles"
});
const { name, startTime, endTime, totalDistance, totalDuration } = routeLayer.routeInfo;
console.log(`Route name: ${name}`);
console.log(`Start Time: ${formatDate.format(startTime)}`);
console.log(`End Time: ${formatDate.format(endTime)}`);
console.log(`Travel Time: ${formatMinutes.format(totalDuration)} minutes`);
console.log(`Travel Distance: ${formatDistance.format(totalDistance)} meters`);
// Route name: Kenoak Pl, Pomona, California, 91768 — 16561 Valley Blvd, Fontana, California, 92335
// Start Time: 12/7/2020, 3:58:50 PM
// End Time: 12/7/2020, 6:12:20 PM
// Travel Time: 133.5 minutes
// Travel Distance: 173,148 meters
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
Date | more details The end time of the route. | more details | RouteInfo | |
Number | more details The local time offset (in minutes) for the end time. | more details | RouteInfo | |
Polyline | more details Polyline representing the route's geometry. | more details | RouteInfo | |
String | more details User specified route name. | more details | RouteInfo | |
Date | more details The start time of the route. | more details | RouteInfo | |
Number | more details The local time offset (in minutes) for the start time. | more details | RouteInfo | |
Number | more details Total distance traveled in meters. | more details | RouteInfo | |
Number | more details Total time in minutes. | more details | RouteInfo | |
String | more details For RouteInfo the type is always "route-info". | more details | RouteInfo |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
endTime Date
-
The end time of the route.
-
endTimeOffset Number
-
The local time offset (in minutes) for the end time.
-
geometry Polyline
-
Polyline representing the route's geometry.
-
name String
-
User specified route name.
-
startTime Date
-
The start time of the route.
-
startTimeOffset Number
-
The local time offset (in minutes) for the start time.
-
totalDistance Number
-
Total distance traveled in meters.
-
totalDuration Number
-
Total time in minutes.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
RouteInfo | more details | more details | RouteInfo | |
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | RouteInfo | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Graphic | more details | more details | RouteInfo | |
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | RouteInfo |
Method Details
-
Since: ArcGIS API for JavaScript 4.24
-
Creates a RouteInfo from the parsed Graphic. The method assumes that the graphic's attributes conform to the route layer item schema.
Parameter:graphic GraphicoptionalA Graphic instance.
Returns:Type Description RouteInfo A RouteInfo instance.
-
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 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.
Returns:Type Description * Returns a new instance of this class.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
toGraphic(){Graphic}Since: ArcGIS API for JavaScript 4.24
-
Creates a Graphic from the RouteInfo instance. The resulting graphic will have attributes that conform to the route layer item schema.
Returns:Type Description Graphic A Graphic instance.
-
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.