RouteInfo | API Reference | ArcGIS Maps SDK for JavaScript 4.32

A RouteInfo contains information about a solved route including the routes geometry and overall distance and time.

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 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

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Date\|null\|undefined	The end time of the route.	RouteInfo
Number\|null\|undefined	The local time offset (in minutes) for the end time.	RouteInfo
Polyline\|null\|undefined	Polyline representing the route's geometry.	RouteInfo
String\|null\|undefined	User specified route name.	RouteInfo
PopupTemplate\|null\|undefined	The template for displaying content in a Popup when the graphic is selected.	RouteInfo
Date\|null\|undefined	The start time of the route.	RouteInfo
Number\|null\|undefined	The local time offset (in minutes) for the start time.	RouteInfo
Number\|null\|undefined	Total distance traveled in meters.	RouteInfo
Number\|null\|undefined	Total time in minutes.	RouteInfo
String	For RouteInfo the type is always "route-info".	RouteInfo

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

endTime Property endTime Date |null |undefinedautocast

The end time of the route.

endTimeOffset Property endTimeOffset Number |null |undefined

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

geometry Property geometry Polyline |null |undefinedautocast

Polyline representing the route's geometry.

name Property name String |null |undefined

User specified route name.

popupTemplate Property popupTemplate PopupTemplate |null |undefinedautocast Since: ArcGIS Maps SDK for JavaScript 4.30 RouteInfo since 4.23, popupTemplate added at 4.30.

The template for displaying content in a Popup when the graphic is selected.

startTime Property startTime Date |null |undefinedautocast

The start time of the route.

startTimeOffset Property startTimeOffset Number |null |undefined

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

totalDistance Property totalDistance Number |null |undefined

Total distance traveled in meters.

totalDuration Property totalDuration Number |null |undefined

Total time in minutes.

type Property type Stringreadonly

For RouteInfo the type is always "route-info".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
RouteInfo	Creates a RouteInfo from the parsed Graphic.	RouteInfo
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	RouteInfo
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 RouteInfo instance.	RouteInfo
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	RouteInfo

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){RouteInfo}static Since: ArcGIS Maps SDK for JavaScript 4.24 RouteInfo since 4.23, fromGraphic added at 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 Graphic

optional

A Graphic instance.

Returns

Type	Description
RouteInfo	A RouteInfo instance.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	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 RouteInfo since 4.23, toGraphic added at 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 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.