RouteResult

Property Overview

Property Details

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.

directionLines FeatureSet

Since: ArcGIS API for JavaScript 4.23

Direction lines contains a set of line features for each segment of the route. This feature set can be used to visualize the turn-by-turn directions on a map.

This feature set is only available if the RouteParameters properties returnDirections and directionsOutputType are true and "featureset" respectively.

See also:

• directionsOutputType

directionPoints FeatureSet

Since: ArcGIS API for JavaScript 4.23

Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. This feature set contains the route's turn-by-turn directions.

This feature set is only available if the RouteParameters properties returnDirections and directionsOutputType are true and "featureset" respectively.

See also:

• directionsOutputType

directions DirectionsFeatureSet

Route directions are returned if RouteParameters.returnDirections = true and RouteParameters.directionsOutputType is not set to "featuresets"`.

See also:

• RouteParameters.returnDirections

route Graphic

The Route graphic that is returned if RouteParameters.returnRoutes = true.

See also:

• RouteParameters.returnRoutes

routeName String

The name of the route.

stops Graphic[]

Array of stops. Returned only if RouteParameters.returnStops = true.

See also:

• RouteParameters.returnStops

traversedEdges FeatureSet

Since: ArcGIS API for JavaScript 4.24

This provides access to the edges that are traversed while solving a network analysis layer.

traversedJunctions FeatureSet

Since: ArcGIS API for JavaScript 4.24

This provides access to the junctions that are traversed while solving a network analysis layer.

traversedTurns FeatureSet

Since: ArcGIS API for JavaScript 4.24

This provides access to the turns that are traversed while solving a network analysis layer.

Method Overview

Method Details

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.

own(handleOrHandles)inherited

Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));

Parameter:

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

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.