RouteResult

Class: esri/rest/support/RouteResult
Inheritance: RouteResult Accessor
Since: ArcGIS API for JavaScript 4.0

The result from route. The RouteResult properties are dependent on the RouteParameters inputs. For example, directions are only returned if RouteParameters.returnDirections is set to true.

See also:

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
Stringmore details

The name of the class.

more detailsAccessor
DirectionsFeatureSetmore details

Route directions are returned if RouteParameters.returnDirections = true.

more detailsRouteResult
Graphicmore details

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

more detailsRouteResult
Stringmore details

The name of the route.

more detailsRouteResult
Graphic[]more details

Array of stops.

more detailsRouteResult

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.

Route directions are returned if RouteParameters.returnDirections = true.

See also:
route Graphic

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

See also:
routeName String

The name of the route.

stops Graphic[]

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

See also:

Method Overview

Name Return Type Summary Class
*more details

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

more detailsRouteResult
Objectmore details

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

more detailsRouteResult

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.
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.

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