RouteParameters

Use this property to specify whether the operation should accumulate values other than the value specified for impedanceAttribute. For example, if your impedanceAttribute is set to TravelTime, the total travel time for the route will be calculated by the operation. However, if you also want to calculate the total distance of the route in miles, you can specify Miles as the value for the accumulateAttributes property.

Known Value
kilometers
miles
meters
minutes
time-at-1kph
travel-time
truck-minutes
truck-travel-time
walk-time

See also

• Network attributes

• accumulateAttributeNames

An authorization string used to access a resource or service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.

See also

• API keys

• Display a map tutorial - get an access token

const stops = new FeatureSet({
  features: [
    new Graphic({
      geometry: new Point({
        x: -117.1949676,
        y: 34.0571844
      })
    }),
    new Graphic({
      geometry: new Point({
        x: -117.0619917,
        y: 34.0010284
      })
    })
  ]
});

const routeParameters = new RouteParameters({
  apiKey: "YOUR_API_KEY",
  stops
});

const routeURL = "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World";

const routeContainer = await route.solve(routeURL, routeParameters);
const routeLayer = routeContainer.routeResults[0].route;

const { attributes, geometry } = routeLayer;
view.graphics.add(new Graphic({
  attributes,
  geometry,
  symbol: {
    type: "simple-line",
    color: "green",
    width: "8px"
  }
}));

Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this property. For example, you can choose to never use toll roads, avoid them as much as possible, or prefer them.

See also

• attributeParameterValues

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

The language that will be used when generating travel directions. This parameter applies only when the returnDirections parameter is set to true. The service supports generating directions in the following languages: ar, bg, bs, ca, cs, da, de, el, en, es, et, fi, fr, he, hr, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-HK and zh-TW.

See also

• directionsLanguage

Specify the units for displaying travel distance in the driving directions. This property applies only when the returnDirections property is set to true.

See also

• directionsLengthUnits

Define the content and verbosity of the driving directions. This property applies only when the returnDirections property is set to true.

See also

• directionsOutputType

Specify the name of the formatting style for the directions. This property applies only when the returnDirections property is set to true.

See also

• directionsStyleName

Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St. for 5 minutes." The units for all the time attributes is minutes.

Known Value
minutes
time-at-1-kph
travel-time
truck-minutes
truck-travel-time
walk-time

See also

• directionsTimeAttributeName

Use this property to specify whether the operation should reorder stops to find the optimized route. If the property value is false, the operation returns a route that visits stops in the order you define. If the parameter value is true, the operation finds the best order to visit the stops. The operation will account for a variety of variables so that the total travel distance or travel time for the route is minimized. You can elect to preserve the origin and the destination stops while allowing the operation to reorder intermediary stops by setting the preserveFirstStop and preserveLastStop properties.

See also

• findBestSequence

Since

ArcGIS Maps SDK for JavaScript 4.24

Use this property to specify the number of decimal places in the response geometries returned by solve operation. This applies to x- and y-values only (not m- or z-values).

See also

• geometryPrecision

Since

ArcGIS Maps SDK for JavaScript 4.24

Use this property to specify the number of decimal places in the response geometries returned by solve operation. This applies to m-value only (not x-,y- or z-values).

See also

• geometryPrecisionM

Since

ArcGIS Maps SDK for JavaScript 4.24

Use this property to specify the number of decimal places in the response geometries returned by a solve operation. This applies to z-value only (not x-,y- or m-values).

See also

• geometryPrecisionZ

Specify whether invalid input locations should be ignored when finding the best solution. An input point is deemed invalid by the operation if it is not within the maximum snap tolerance of any traversable street. When true invalid points are ignored. When false any invalid point in your request will cause the operation to return a failure.

See also

• ignoreInvalidLocations

Specifies the impedance.

Impedance is a value that quantifies travel along the transportation network. Travel distance is an example of impedance; it quantifies the length of walkways and road segments. Similarly, drive time—the typical time it takes to drive a car along a road segment—is an example of impedance. This property will be ignored if travelMode is set.

Known Value
kilometers
miles
meters
minutes
time-at-1kph
travel-time
truck-minutes
truck-travel-time
walk-time

See also

• impedanceAttributeName

Since

ArcGIS Maps SDK for JavaScript 5.0

This property specifies settings that affect how inputs are located, such as the maximum search distance to use when locating the inputs on the network or the network sources being used for locating. To restrict locating on a portion of the source, you can specify a where clause for a source.

See also

• locateSettings

Use this property to specify by how much you want to simplify the route geometry returned by the operation. Simplification maintains critical points on a route, such as turns at intersections, to define the essential shape of the route and removes other points. The value of this property, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

The units are specified with the outputGeometryPrecisionUnits parameter.

See also

• outputGeometryPrecision

Use this property to specify the units for the value specified for the outputGeometryPrecision parameter. The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

See also

• outputGeometryPrecisionUnits

Use this property to specify the type of route features that are output by the operation. This parameter is applicable only if the returnRoutes parameter is set to true.

Possible Value	Description
none	Do not return any shapes for the routes.
straight	Return a straight line between the stops.
true-shape	Return the exact shape of the resulting route that is based on the underlying streets.
true-shape-with-measure	Return the exact shape of the resulting route that is based on the underlying streets and include route measurements that keep track of the cumulative travel time or travel distance along the route relative to the first stop.

See also

• outputLines

Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation.

See also

• outSR

Since

ArcGIS Maps SDK for JavaScript 4.24

Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.

See also

• overrides

Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or a time delay spent at a railroad crossing.

See also

• barriers

Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

See also

• polygonBarriers

Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier.

See also

• polylineBarriers

Use this property to indicate whether the operation should keep the first stop fixed when reordering the stops. This property is applicable only if the findBestSequence parameter value is true.

See also

• preserveFirstStop

Use this property to indicate whether the operation should keep the last stop fixed when reordering the stops. This property is applicable only if the findBestSequence parameter value is true.

See also

• preserveLastStop

Since

ArcGIS Maps SDK for JavaScript 4.24

Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output.

See also

• preserveObjectID

Use this property to specify which restrictions should be honored by the operation. A restriction represents a driving preference or requirement. This value is ignored if travelMode is specified.

Known Value
any-hazmat-prohibited
avoid-carpool-roads
avoid-express-lanes
avoid-ferries
avoid-gates
avoid-limited-access-roads
avoid-private-roads
avoid-roads-unsuitable-for-pedestrians
avoid-stairways
avoid-toll-roads
avoid-toll-roads-for-trucks
avoid-truck-restricted-roads
avoid-unpaved-roads
axle-count-restriction
driving-a-bus
driving-a-taxi
driving-a-truck
driving-an-automobile
driving-an-emergency-vehicle
height-restriction
kingpin-to-rear-axle-length-restriction
length-restriction
preferred-for-pedestrians
riding-a-motorcycle
roads-under-construction-prohibited
semi-or-tractor-with-one-or-more-trailers-prohibited
single-axle-vehicles-prohibited
tandem-axle-vehicles-prohibited
through-traffic-prohibited
truck-with-trailers-restriction
use-preferred-hazmat-routes
use-preferred-truck-routes
walking
weight-restriction

See also

• restrictionAttributeNames

Use this property to restrict or permit the route from making U-turns at junctions. This value is ignored if travelMode is specified.

See also

• restrictUTurns

Specify whether point barriers will be returned by the routing operation.

See also

• returnBarriers

Specify whether the operation should generate driving directions for each route. If true directions are configured based on the values for the directionsLanguage, directionsOutputType, directionsStyleName, and directionsLengthUnits properties.

See also

• returnDirections

Since

ArcGIS Maps SDK for JavaScript 5.0

Specify whether the service will return empty results instead of the error property when the request fails. If true errors, if any, are returned in the RouteSolveResult.messages property when a route is solved.

See also

• returnEmptyResults

Specify whether polygon barriers will be returned by the routing operation.

See also

• returnPolygonBarriers

Specify whether polyline barriers will be returned by the routing operation.

See also

• returnPolylineBarriers

Use this property to specify if the operation should return routes. If true, the shape of the routes depends on the value for the outputLines property.

See also

• returnRoutes

Use this property to specify whether stops will be returned by the routing operation.

See also

• returnStops

Since

ArcGIS Maps SDK for JavaScript 4.24

Specify whether traversed edges will be returned by the operation.

See also

• returnTraversedEdges

Since

ArcGIS Maps SDK for JavaScript 4.24

Specify whether traversed junctions will be returned by the operation.

See also

• returnTraversedJunctions

Since

ArcGIS Maps SDK for JavaScript 4.24

Specify whether traversed turns will be returned by the operation.

See also

• returnTraversedTurns

Include z values for the returned geometries if supported by the underlying network.

See also

• returnZ

Indicates the time that travel should begin. Please note that the "now" keyword is only supported on servers with a version of 10.8.1 or greater. If a start time is not provided, the route is based on historically average traffic conditions, average speeds, and posted speed limits.

When a startTime of "now" is used the startTimeIsUTC property is ignored.

See also

• startTime

• NetworkServiceDescription

Specify the time zone or zones of the startTime property.

See also

• startTimeIsUTC

Specifies the locations the output route or routes will visit.

See also

• stops

// Define stops using a FeatureSet.
const routeParameters = new RouteParameters({
  stops: new FeatureSet({
      features: [
      new Graphic({
        attributes: { Name: "Redlands" },
        geometry: new Point({ x: -117.1825, y: 34.054722 })
      }),
      new Graphic({
        attributes: { Name: "Palm Springs" },
        geometry: new Point({ x: -116.545278, y: 33.830278 })
      })
    ]
  })
});

// Define stops using a collection of Stops.
const routeParameters = new RouteParameters({
  stops: new Collection([
    new Stop({ name: "Redlands", geometry: { x: -117.1825, y: 34.054722 }}),
    new Stop({ name: "Palm Springs", geometry: { x: -116.545278, y: 33.830278 }})
  ])
});

Since

ArcGIS Maps SDK for JavaScript 4.24

Specify whether the time window start and end property values on stops are in UTC or geographically local time.

See also

• timeWindowsAreUTC

A travel mode represents a means of transportation, such as driving or walking. Travel modes define the physical characteristics of a vehicle or pedestrian.

Use fetchServiceDescription() to obtain a list of predefined travel modes and the default travel mode that is used if one is not specified in a routing reqest.

See also

• Introduction to travel modes

• Default travel modes

• travelMode

// Display the fastest walking time route between two existing graphics.
const apiKey = "<your-api-key>";
const url = "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World";

// Obtain the routing service's description. The description contains all preset travel modes.
const serviceDescription = await networkService.fetchServiceDescription(url, apiKey);

// Find the named travel mode called "Walking Time".
const { supportedTravelModes } = serviceDescription;
const travelMode = supportedTravelModes.find((mode) => mode.name === "Walking Time");

// Construct the route parameter object.
const routeParameters = new RouteParameters({
  apiKey,
  stops: new FeatureSet({
    features: view.graphics.toArray()
  }),
  returnDirections: true,
  travelMode
});

// Solve the route and add the path representing the fastest walk path to the map.
const routeContainer = await route.solve(url, routeParameters);
for (const routeResult of routeContainer.routeResults) {
  const { routeLayer } = routeResult;
  routeLayer.symbol = {
    type: "simple-line",
    color: [5, 150, 255],
    width: 3
  };
  view.graphics.add(routeLayer);
}

Specify whether hierarchy should be used when finding the shortest paths. This value is ignored if a travelMode is specified.

See also

• useHierarchy

Use this property to indicate whether the operation should consider time windows specified on the stops when finding the best route. The time windows are specified on stops using start and end time window properties.

See also

• useTimeWindows

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.

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

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