DirectionsFeatureSet

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

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

The name of the layer's primary display field.

more details
more detailsFeatureSet
Boolean

Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation.

more details
more detailsFeatureSet
Extent

The extent of the route.

more details
more detailsDirectionsFeatureSet
Graphic[]

An array of graphics containing the directions.

more details
more detailsDirectionsFeatureSet
Field[]

Information about each field.

more details
more detailsFeatureSet
String

The geometry type of the FeatureSet.

more details
more detailsDirectionsFeatureSet
Polyline

A single polyline representing the route.

more details
more detailsDirectionsFeatureSet
String

The ID of the route returned from the server.

more details
more detailsDirectionsFeatureSet
String

Name specified in RouteParameters.stops.

more details
more detailsDirectionsFeatureSet
SpatialReference

When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default.

more details
more detailsFeatureSet
Object[]

Lists additional information about the directions depending on the value of RouteParameters.directionsOutputType.

more details
more detailsDirectionsFeatureSet
Number

Actual drive time calculated for the route.

more details
more detailsDirectionsFeatureSet
Number

The length of the route as specified in the units set in RouteParameters.directionsLengthUnits.

more details
more detailsDirectionsFeatureSet
Number

The total time calculated for the route as specified in the units set in RouteParameters.directionsTimeAttribute.

more details
more detailsDirectionsFeatureSet

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

displayFieldNameString inherited

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.

exceededTransferLimitBoolean inherited

Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. If maxRecordCount is configured for a layer, exceededTransferLimit will be true if a query matches more than the maxRecordCount features. It will be false otherwise. Supported by ArcGIS Server version 10.1 and later.

extentExtent

The extent of the route.

featuresGraphic[]

An array of graphics containing the directions.

Since: ArcGIS API for JavaScript 4.1

Information about each field.

geometryTypeString

The geometry type of the FeatureSet. This value is always esriGeometryPolyline.

mergedGeometryPolyline

A single polyline representing the route.

routeIdString

The ID of the route returned from the server.

routeNameString

Name specified in RouteParameters.stops.

spatialReferenceSpatialReference inherited

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.

stringsObject[]

Lists additional information about the directions depending on the value of RouteParameters.directionsOutputType.

totalDriveTimeNumber

Actual drive time calculated for the route.

totalLengthNumber

The length of the route as specified in the units set in RouteParameters.directionsLengthUnits.

See also:

totalTimeNumber

The total time calculated for the route as specified in the units set in RouteParameters.directionsTimeAttribute.

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 detailsFeatureSet
Object

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

more details
more detailsFeatureSet

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}inherited

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.