DirectionsViewModel

let directions = new Directions({
  viewModel: { // autocasts as new DirectionsViewModel
    impedanceAttribute: "TravelTime" //attribute name used to specify impedance
  }
});

Property Overview

Property Details

apiKey String

Since: ArcGIS API for JavaScript 4.19

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.

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

goToOverride GoToOverride

Since: ArcGIS API for JavaScript 4.8

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also:

• MapView
• SceneView

Example:

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};

impedanceAttribute String

The network attribute name to be used as the impedance attribute in the analysis. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attribute names listed in the Service Directory under Network Dataset -> Network Attributes as Usage Type: esriNAUTCost. You can also specify a value of none to indicate that no network attributes should be used for impedance. If you specify an empty array, it will default to the default of the service.

For example, set impedanceAttribute = "Time" for the quickest route and impedanceAttribute = "Length" for shortest drive, assuming the service has those two esriNAUTCost attributes.

For more information, see Understanding the network attribute.

lastRoute Objectreadonly

The most recent route result. Returns an object containing properties for any barriers used when generating the route, messages that may arise when solving the route, and finally an array of returned RouteResults.

Properties:

barriers Graphic[] Array of graphics representing the point barriers. For a list of properties returned for each barrier, see the barriers help documentation.

messages Object[] An array of messages serialized to JSON. Specification: description String A descriptive message of the returned mesage. type Number Number indicating the message type returned from the service. This number correlates to one of the possible values listed below. Number Value 0 informative 1 process-definition 2 process-start 3 process-stop 50 warning 100 error 101 empty 200 abort

polygonBarriers Graphic[] Array of graphics representing the polygon barriers. For a list of properties returned for each barrier, see the barriers help documentation.

polylineBarriers Graphic[] Array of graphics representing the polygon barriers. For a list of properties returned for each barrier, see the barriers help documentation.

routeResults RouteResult An array of RouteResults.

Default Value:null

maxStops Number

The maximum number of stops allowed for routing.

Default Value:50

routeParameters RouteParameters

Route Parameters object used to call the service. Please refer to the RouteParameters documentation for the list of available settings.

routeServiceUrl Stringautocast

The URL of the REST endpoint of the Route service.

Default Value:"https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World"

routeSymbol SimpleLineSymbol

Defines the symbol used to draw the route on the map.

selectedTravelMode TravelMode

The selected travel mode. More information can be found in the ArcGIS Online documentation.

Properties:

description String The description explaining the selected travel mode. A listing of these descriptions can be found in the ArcGIS Online documentation.

id String The unique identifier specific for this travel mode.

impedanceAttributeName String The cost attribute on which to optimize the analysis. For example Miles, Minutes, Travel Time, Kilometers, TimeAt1KPH, WalkTime, and TruckTravelTime. Take note that attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online.

name String Name of the travel mode. Users of ArcGIS Online or ArcGIS Enterprise can define custom travel modes inside their Organization settings. Authors of stand alone Network Analysis Services can define their own travel modes inside a network dataset.

timeAttributeName String The time-based cost attribute for reporting directions. For example, Minutes, Travel Time, TimeAt1KPH, WalkTime, and TruckTravelTime.

Default Value:null | 'Driving Time'

serviceDescription Objectreadonly

The Service Description object returned by the Route REST Endpoint. This object contains service specific details like available Cost attributes, supported Restrictions, default Attribute Parameter Values, Service Limits (like maximum input stop count), default Impedance Attribute, etc. This information is useful when implementing complex logistics scenarios operating with limitations or preferences on vehicle or stop properties, for example avoiding toll roads, dealing with hazardous materials, working with stop service times, etc.

Default Value:null

state Stringreadonly

The current state of the view model.

Possible Values:"disabled"|"ready"

Default Value:disabled

stops Collection<Graphic>

An array of graphics that define the stop locations along the route.

stopSymbols Object

The default stop symbols used to display locations between the origin and final destination.

Properties:

first Symbol optional The first stop symbol.

middle Symbol optional The middle stop symbol.

last Symbol optional The last stop symbol.

unlocated Symbol optional An unlocated stop symbol.

waypoint Symbol optional A waypoint stop symbol.

timeAttribute Objectreadonly

The name of the network attribute to use for the drive time when computing directions.

Properties:

name String The name of the network attribute to use for the drive time when computing directions.

units String optional The units to use when calculating drive time for directions. Possible Values:"feet"|"kilometers"|"meters"|"miles"|"nautical-miles"|"yards"

travelModes TravelMode[]readonly

Array of objects containing properties specific to either an ArcGIS service or organization's travel modes. More information can be found in the ArcGIS Online documentation.

view MapView|SceneView

The view from which the widget will operate.

Method Overview

Method Details

centerAt(stopOrManeuver)

Centers the map at the specified maneuver or stop.

Parameter:

stopOrManeuver Graphic The stop or maneuver where the map should be centered.

clearHighlights()

Clears any highlighted route segments.

clearResults()

Removes the route directions from the directions list, leaving the inputs untouched. The route and locations persist on the map.

getCostAttribute(attributeName){String}

Returns cost attribute name specific to a particular route service. This can be used as a travel mode impedance.

Parameter:

attributeName String The attribute name specifying the cost attribute used as an impedance.

Returns:

Type	Description
String	Cost attribute name specific to the route service.

getDirections(){Promise<RouteResult>}

Calculate the route to the input locations and display the list of directions.

Returns:

Type	Description
Promise<RouteResult>	When resolved, returns an object containing the calculated RouteResult.

highlightSegment(maneuver)

Highlights the specified route segment on the map.

Parameter:

maneuver Graphic The route segment to highlight.

load(){Promise}

This method should be called to load the view model's routing resources.

You must first call this before using DirectionsViewModel.

Returns:

Type	Description
Promise	When resolved, the view model has loaded the route service metadata necessary for routing.

reset()

Resets the state of the ViewModel, clearing all the input stops and results in the widget and in the map.

zoomToRoute()

Zoom so that the full route is displayed within the current map extent.

Type Definitions

TravelMode

Array of objects containing properties specific to either an ArcGIS service or organization's travel modes. More information can be found in the ArcGIS Online documentation.

Properties:

description String optional The description explaining the selected travel mode. A listing of these descriptions can be found in the ArcGIS Online documentation.

id String optional The unique identifier specific for this travel mode.

impedanceAttributeName String optional The cost attribute on which to optimize the analysis. For example Miles, Minutes, Travel Time, Kilometers, TimeAt1KPH, WalkTime, and TruckTravelTime. Take note that attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online.

name String optional Name of the travel mode. Users of ArcGIS Online or ArcGIS Enterprise can define custom travel modes inside their Organization settings. Authors of stand alone Network Analysis Services can define their own travel modes inside a network dataset.

timeAttributeName String optional The time-based cost attribute for reporting directions. For example, Minutes, Travel Time, TimeAt1KPH, WalkTime, and TruckTravelTime.