Class: RouteResultE-mail This Topic Printable Version Give Us Feedback

Description

Class added v1.4.

The result from the Route Task. The RouteResult properties are dependent on the RouteParameter inputs. For example, directions are only returned if RouteParameters.returnDirections is set to "true". RouteResult has no constructor.

Class hierarchy

esri.tasks.RouteResult

Properties

Property Type Description
directions DirectionsFeatureSet Route directions are returned if RouteParameters.returnDirections is set to true. For more information, see Getting driving directions.
route Graphic The Route graphic that is returned if RouteParameters.returnRoutes is true. For the list of attributes associated with the route, see the "Route properties" section in Finding the best route.
routeName String The name of the route.
stops Graphic[] Array of stops. Returned only if RouteParameters.returnStops is true. For the list of attributes returned for each stop, see the "Stop properties" section in Finding the best route.
Properties Detail

<DirectionsFeatureSet> directions

Route directions are returned if RouteParameters.returnDirections is set to true. For more information, see Getting driving directions.

<Graphic> route

The Route graphic that is returned if RouteParameters.returnRoutes is true. For the list of attributes associated with the route, see the "Route properties" section in Finding the best route.

<String> routeName

The name of the route.

<Graphic[]> stops

Array of stops. Returned only if RouteParameters.returnStops is true. For the list of attributes returned for each stop, see the "Stop properties" section in Finding the best route.