RouteParameters

AMD: require(["esri/rest/support/RouteParameters"], (RouteParameters) => { /* code goes here */ });
ESM: import RouteParameters from "@arcgis/core/rest/support/RouteParameters";
Class: esri/rest/support/RouteParameters
Inheritance: RouteParameters Accessor
Since: ArcGIS API for JavaScript 4.20

Input parameters for route. Specifies details such as stop locations, barrier locations, the impedance attribute, etc.

See also:

Constructors

new RouteParameters(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
String[]more details

Use this property to specify whether the operation should accumulate values other than the value specified for impedanceAttribute.

more detailsRouteParameters
Stringmore details

An authorization string used to access a resource or service.

more detailsRouteParameters
AttributeParameterValue[]more details

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.

more detailsRouteParameters
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The language that will be used when generating travel directions.

more detailsRouteParameters
Stringmore details

Specify the units for displaying travel distance in the driving directions.

more detailsRouteParameters
Stringmore details

Define the content and verbosity of the driving directions.

more detailsRouteParameters
Stringmore details

Specify the name of the formatting style for the directions.

more detailsRouteParameters
Stringmore details

Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St.

more detailsRouteParameters
Booleanmore details

Use this property to specify whether the operation should reorder stops to find the optimized route.

more detailsRouteParameters
Numbermore details

Use this property to specify the number of decimal places in the response geometries returned by solve operation.

more detailsRouteParameters
Numbermore details

Use this property to specify the number of decimal places in the response geometries returned by solve operation.

more detailsRouteParameters
Numbermore details

Use this property to specify the number of decimal places in the response geometries returned by a solve operation.

more detailsRouteParameters
Booleanmore details

Specify whether invalid input locations should be ignored when finding the best solution.

more detailsRouteParameters
Stringmore details

Specifies the impedance.

more detailsRouteParameters
Numbermore details

Use this property to specify by how much you want to simplify the route geometry returned by the operation.

more detailsRouteParameters
Stringmore details

Use this property to specify the units for the value specified for the outputGeometryPrecision parameter.

more detailsRouteParameters
Stringmore details

Use this property to specify the type of route features that are output by the operation.

more detailsRouteParameters
SpatialReferencemore details

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

more detailsRouteParameters
Objectmore details

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

more detailsRouteParameters
Collection<PointBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrlmore details

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.

more detailsRouteParameters
Collection<PolygonBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrlmore details

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.

more detailsRouteParameters
Collection<PolylineBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrlmore details

Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets.

more detailsRouteParameters
Booleanmore details

Use this property to indicate whether the operation should keep the first stop fixed when reordering the stops.

more detailsRouteParameters
Booleanmore details

Use this property to indicate whether the operation should keep the last stop fixed when reordering the stops.

more detailsRouteParameters
Booleanmore details

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.

more detailsRouteParameters
String[]more details

Use this property to specify which restrictions should be honored by the operation.

more detailsRouteParameters
Stringmore details

Use this property to restrict or permit the route from making U-turns at junctions.

more detailsRouteParameters
Booleanmore details

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

more detailsRouteParameters
Booleanmore details

Specify whether the operation should generate driving directions for each route.

more detailsRouteParameters
Booleanmore details

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

more detailsRouteParameters
Booleanmore details

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

more detailsRouteParameters
Booleanmore details

Use this property to specify if the operation should return routes.

more detailsRouteParameters
Booleanmore details

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

more detailsRouteParameters
Booleanmore details

Specify whether traversed edges will be returned by the operation.

more detailsRouteParameters
Booleanmore details

Specify whether traversed junctions will be returned by the operation.

more detailsRouteParameters
Booleanmore details

Specify whether traversed turns will be returned by the operation.

more detailsRouteParameters
Booleanmore details

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

more detailsRouteParameters
Date|Stringmore details

Indicate the time that travel should begin.

more detailsRouteParameters
Booleanmore details

Specify the time zone or zones of the startTime property.

more detailsRouteParameters
Collection<Stop>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrlmore details

Specifies the locations the output route or routes will visit.

more detailsRouteParameters
Booleanmore details

Specify whether the timeWindowStart and timeWindowEnd property values on stops are specified in UTC or geographically local time.

more detailsRouteParameters
TravelModemore details

A travel mode represents a means of transportation, such as driving or walking.

more detailsRouteParameters
Booleanmore details

Specify whether hierarchy should be used when finding the shortest paths.

more detailsRouteParameters
Booleanmore details

Use this property to indicate whether the operation should consider time windows specified on the stops when finding the best route.

more detailsRouteParameters

Property Details

accumulateAttributes String[]

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.

See also:
apiKey String

An authorization string used to access a resource or service. API keys are generated and managed in the ArcGIS Developer dashboard. 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:
Example:
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"
  }
}));
attributeParameterValues AttributeParameterValue[]

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:
declaredClass Stringreadonly inherited

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

directionsLanguage String

The language that will be used when generating travel directions. This property applies only when the returnDirections property is set to true.

See also:
directionsLengthUnits String

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

Possible Values:"centimeters"|"decimal-degrees"|"decimeters"|"feet"|"inches"|"kilometers"|"meters"|"miles"|"millimeters"|"nautical-miles"|"points"|"yards"

See also:
directionsOutputType String

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

Possible Values:"complete"|"complete-no-events"|"featuresets"|"instructions-only"|"standard"|"summary-only"

See also:
directionsStyleName String

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

Possible Values:"desktop"|"navigation"|"campus"

See also:
directionsTimeAttribute String

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.

Possible Values:"travel-time"|"truck-travel-time"|"walk-time"|"minutes"|"truck-time"

See also:
findBestSequence Boolean

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:
geometryPrecision Number
Since: ArcGIS API 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:
geometryPrecisionM Number
Since: ArcGIS API 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:
geometryPrecisionZ Number
Since: ArcGIS API 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:
ignoreInvalidLocations Boolean

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:
impedanceAttribute String

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.

Possible Values:"kilometers"|"miles"|"minutes"|"travel-time"|"truck-minutes"|"truck-travel-time"|"walk-time"

See also:
outputGeometryPrecision Number

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:
outputGeometryPrecisionUnits String

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.

Possible Values:"centimeters"|"decimal-degrees"|"decimeters"|"feet"|"inches"|"kilometers"|"meters"|"miles"|"millimeters"|"nautical-miles"|"points"|"yards"

See also:
outputLines String

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.

Possible Values:"none"|"straight"|"true-shape"|"true-shape-with-measure"

Default Value:"true-shape"
See also:
outSpatialReference SpatialReference

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

See also:
overrides Object
Since: ArcGIS API 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:

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:

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:

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:
preserveFirstStop Boolean

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:
preserveLastStop Boolean

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:
preserveObjectID Boolean
Since: ArcGIS API 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:
restrictionAttributes String[]

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.

Possible Values:"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"|"string"

See also:
restrictUTurns String

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

Possible Values:"allow-backtrack"|"at-dead-ends-only"|"no-backtrack"|"at-dead-ends-and-intersections"

See also:
returnBarriers Boolean

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

Default Value:false
See also:
returnDirections Boolean

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.

Default Value:false
See also:
returnPolygonBarriers Boolean

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

Default Value:false
See also:
returnPolylineBarriers Boolean

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

Default Value:false
See also:
returnRoutes Boolean

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.

Default Value:true
See also:
returnStops Boolean

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

Default Value:false
See also:
returnTraversedEdges Boolean
Since: ArcGIS API for JavaScript 4.24

Specify whether traversed edges will be returned by the operation.

See also:
returnTraversedJunctions Boolean
Since: ArcGIS API for JavaScript 4.24

Specify whether traversed junctions will be returned by the operation.

See also:
returnTraversedTurns Boolean
Since: ArcGIS API for JavaScript 4.24

Specify whether traversed turns will be returned by the operation.

See also:
returnZ Boolean

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

Default Value:true
See also:
startTime Date|String

Indicate the time that travel should begin.

For RouteParameters the startTime is always "now".

See also:
startTimeIsUTC Boolean

Specify the time zone or zones of the startTime property.

Default Value:true
See also:

Specifies the locations the output route or routes will visit.

See also:
Examples:
// 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 }})
  ])
});
timeWindowsAreUTC Boolean
Since: ArcGIS API for JavaScript 4.24

Specify whether the timeWindowStart and timeWindowEnd property values on stops are specified in UTC or geographically local time.

See also:
travelMode TravelMode

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 networkService.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:
Example:
// 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);
}
useHierarchy Boolean

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

See also:
useTimeWindows Boolean

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 the timeWindowStart and timeWindowEnd properties.

See also:

Method Overview

Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

more detailsRouteParameters
*more details

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

more detailsRouteParameters
Objectmore details

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

more detailsRouteParameters

Method Details

clone(){this}

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.

Returns:
Type Description
this A deep clone of the class instance that invoked this 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.
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.

Type Definitions

AttributeParameterValue

An object describing the parameter values for the attributeParameterValues property of RouteParameters.

Properties:
attributeName String

The name of the restriction.

parameterName String

The name of the parameter associated with the restriction. A restriction can have one or more parameterName properties.

value String|Number

The value for parameterName.

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