A FeatureSet that has properties specific to routing. The features property contains the turn by turn directions text and geometry of the route. The attributes for each feature provide information associated with the corresponding route segment. The following attributes are returned:
- text - The direction text
- length - The length of the route segment
- time - The time to travel along the route segment
- ETA - The estimated time of arrival at the route segment in the local time
- maneuverType - The type of maneuver that the direction represents
The name of the class.more details
The name of the layer's primary display field.more details
Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation.more details
The extent of the route.more details
An array of graphics containing the directions.more details
Information about each field.more details
The geometry type of the FeatureSet.more details
A single polyline representing the route.more details
The geometry used to query the features.more details
The ID of the route returned from the server.more details
Name specified in RouteParameters.stops.more details
When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default.more details
Lists additional information about the directions depending on the value of RouteParameters.directionsOutputType.more details
Actual drive time calculated for the route.more details
The length of the route as specified in the units set in RouteParameters.directionsLengthUnits.more details
The total time calculated for the route as specified in the units set in RouteParameters.directionsTimeAttribute.more details
The name of the class. The declared class name is formatted as
The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. This is only applicable when the FeatureSet is returned from a task. It is ignored when the FeatureSet is used as input to a geoprocessing task.
Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. If
maxRecordCountis configured for a layer,
trueif a query matches more than the
maxRecordCountfeatures. It will be
falseotherwise. Supported by ArcGIS Server version 10.1 and later.
- extent Extent
The extent of the route.
An array of graphics containing the directions.
Information about each field.
- geometryType String
The geometry type of the FeatureSet.
For DirectionsFeatureSet the geometryType is always "polyline".
- mergedGeometry Polyline
A single polyline representing the route.
The geometry used to query the features. It is useful for getting the buffer geometry generated when querying features by distance or getting the query geometry projected in the outSpatialReference of the query. The query geometry is returned only for client-side queries and hosted feature services. The query's returnQueryGeometry must be set to
trueand the layer's capabilities.query.supportsQueryGeometry has to be
truefor the query to return query geometry.
- See also:
- routeId String
The ID of the route returned from the server.
When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. This value can be changed. When a FeatureSet is returned from a task, the value is the result as returned from the server.
Lists additional information about the directions depending on the value of RouteParameters.directionsOutputType.
- totalDriveTime Number
Actual drive time calculated for the route.
- totalLength Number
The length of the route as specified in the units set in RouteParameters.directionsLengthUnits.
- totalTime Number
The total time calculated for the route as specified in the units set in RouteParameters.directionsTimeAttribute.
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
|Object||more details||more details||FeatureSet|
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
jsonparameter 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.
API Reference search results