require(["esri/widgets/Directions"], function(Directions) { /* code goes here */ });
Class: esri/widgets/Directions
Inheritance: Directions Widget Accessor
Since: ArcGIS API for JavaScript 4.6
beta

The Directions Widget provides a way to build driving and walking directions using ArcGIS online and custom Network Analysis Route services. Similar to how the RouteTask works, this widget generates a route finding a least-cost path between multiple points using a specified network. The resulting directions are displayed with detailed turn-by-turn instructions.

The widget wraps pre-built search functionality directly within it so all you need to do is reference the widget within your application. The routing service defaults to the Esri World Route service. This is a subscription based service available through ArcGIS Online. You can use this default or specify your own ArcGIS Server route service. Please see the routeServiceUrl property.

Any types of customizations made to the underlying functionality of the widget should be handled via its viewModel property.

Known Limitations

The Directions widget is currently in its beta release. It should be noted that it is not yet at full parity with the functionality provided in the 3.x version of the Directions widget and is subject to change.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
var directionsWidget = new Directions({
  view: view
});
// Adds the Directions widget below other elements in
// the top right corner of the view
view.ui.add(directionsWidget, {
  position: "top-right",
  index: 2
});

Constructors

new Directions(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.
NameTypeSummaryClass
String | HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
String

The widget's default icon font.

more details
more detailsDirections
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's default label.

more details
more detailsDirections
Number

The maximum number of stops allowed for routing.

more details
more detailsDirections
String

The URL of the REST endpoint of the Route service.

more details
more detailsDirections
SimpleLineSymbol

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

more details
more detailsDirections
SearchProperties

Controls the default properties used when searching.

more details
more detailsDirections
Object

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

more details
more detailsDirections
MapView | SceneView

The view from which the widget will operate.

more details
more detailsDirections
DirectionsViewModel

The view model for this widget.

more details
more detailsDirections

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once.

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

When true, this property indicates whether the widget has been destroyed.

iconClassStringreadonly
Since: ArcGIS API for JavaScript 4.7

The widget's default icon font.

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

labelStringreadonly
Since: ArcGIS API for JavaScript 4.7

The widget's default label.

maxStopsNumber

The maximum number of stops allowed for routing.

Default Value:50
routeServiceUrlStringautocast

The URL of the REST endpoint of the Route service.

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

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

searchPropertiesSearchProperties

Controls the default properties used when searching. Note that the default searchProperties differ slightly from the Search widget.

Default Value:null
stopSymbolsObject

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.

The view from which the widget will operate.

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the DirectionsViewModel class to access all properties and methods on the widget.

Method Overview

NameReturn TypeSummaryClass
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Destroys the widget instance.

more details
more detailsWidget

Emits an event on the instance.

more details
more detailsWidget
Promise<RouteResult>

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

more details
more detailsDirections
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

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

more details
more detailsDirections

Method Details

classes(classNames){String}inherited
Since: ArcGIS API for JavaScript 4.7

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Prior to version 4.7, there were various approaches towards setting CSS classes. These were dependant upon variables, such as whether the classes were:

  • a single static class,
  • multiple static classes, or
  • dynamic classes.

This helper method takes all of these approaches into account and simplifies it to use one single pattern to accommodate these multiple approaches.

Parameter:
classNames Array<(String|String[]|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget
render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
destroy()inherited

Destroys the widget instance.

emit(type, event)inherited
Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object

The event payload.

getDirections(){Promise<RouteResult>}

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

Returns:
TypeDescription
Promise<RouteResult>When resolved, returns an object containing the calculated RouteResult.
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

zoomToRoute()

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

Type Definitions

SearchProperties

Configurable Search properties of the widget.

Properties:
activeSourceIndex Number
optional

Number index indicating the current selected source.

allPlaceholder String
optional

String value used as a hint for input text when searching on multiple sources.

autoNavigate Boolean
optional
Default Value:true

Indicates whether to automatically navigate to the selected result once selected.

autoSelect Boolean
optional

Indicates whether to automatically select and zoom to the first geocoded result.

maxResults Number
optional
Default Value:6

Indicates the maximum number of search results to return.

maxSuggestions Number
optional
Default Value:6

Indicates the maximum number of suggestions to return for the widget's input.

minSuggestCharacters Number
optional
Default Value:1

Indicates the minimum number of characters required before querying for a suggestion.

popupEnabled Boolean
optional
Default Value:false

Indicates whether to display a Popup when a selected result is clicked.

popupOpenOnSelect Boolean
optional
Default Value:true

Indicates whether to show the Popup when a result is selected.

popupTemplate PopupTemplate
optional

A customized PopupTemplate for the selected feature.

resultGraphicEnabled Boolean
optional
Default Value:false

Indicates whether to show a graphic on the map for the selected source.

searchAllEnabled Boolean
optional

Indicates whether to display the option to search all sources.

searchTerm String
optional

The value of the search box input text string.

optional

Specifies the sources to search in the view.

suggestionsEnabled Boolean
optional
Default Value:true

Indicates whether to display suggestions as the user enters input text in the widget.

optional

The view of the widget.

viewModel SearchViewModel
optional

The Search widget's view model.

Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.