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
});

Property Overview

Property Details

containerString|HTMLElement inherited

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.

destroyedBoolean inherited

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

goToOverrideGoToOverride

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);
};

iconClassStringreadonly

Since: ArcGIS API for JavaScript 4.7

The widget's default CSS icon class.

idString inherited

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.

viewMapView|SceneView

The view from which the widget will operate.

viewModelDirectionsViewModelautocast

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

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

Type	Description
String	The computed class name.

See also:

• Guide - Widget development (rendering)

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

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 optional The event payload.

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.

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:

Type	Description
Boolean	Returns 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:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

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 WatchHandle|WatchHandle[] 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:

Type	Description
Object	The 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.

sources Collection<(FeatureLayerSearchSource|LocatorSearchSource)> 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.

view MapView|SceneView optional The view of the widget.

viewModel SearchViewModel optional The Search widget's view model.