RouteResult

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

The result from RouteTask. 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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
DirectionsFeatureSet

Route directions are returned if RouteParameters.returnDirections = true.

more details
more detailsRouteResult
Graphic

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

more details
more detailsRouteResult
String

The name of the route.

more details
more detailsRouteResult
Graphic[]

Array of stops.

more details
more detailsRouteResult

Property Details

declaredClassStringreadonly inherited

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:

routeGraphic

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

See also:

routeNameString

The name of the route.

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

See also:

Method Overview

NameReturn TypeSummaryClass
*

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

more details
more detailsRouteResult
Object

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

more details
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 a product in the ArcGIS platform. 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:
TypeDescription
*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() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.