DirectionsFeatureSet

Class: esri/tasks/support/DirectionsFeatureSet
Inheritance: DirectionsFeatureSet FeatureSet Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.20. Use DirectionsFeatureSet instead.

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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The name of the layer's primary display field.

more detailsFeatureSet
Booleanmore details

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

more detailsFeatureSet
Extentmore details

The extent of the route.

more detailsDirectionsFeatureSet
Graphic[]more details

An array of graphics containing the directions.

more detailsDirectionsFeatureSet
Field[]more details

Information about each field.

more detailsFeatureSet
Stringmore details

The geometry type of the FeatureSet.

more detailsDirectionsFeatureSet
Polylinemore details

A single polyline representing the route.

more detailsDirectionsFeatureSet
Geometrymore details

The geometry used to query the features.

more detailsFeatureSet
Stringmore details

The ID of the route returned from the server.

more detailsDirectionsFeatureSet
Stringmore details

Name specified in RouteParameters.stops.

more detailsDirectionsFeatureSet
SpatialReferencemore details

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

more detailsFeatureSet
Object[]more details

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

more detailsDirectionsFeatureSet
Numbermore details

Actual drive time calculated for the route.

more detailsDirectionsFeatureSet
Numbermore details

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

more detailsDirectionsFeatureSet
Numbermore details

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

more detailsDirectionsFeatureSet

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.

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

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

extent Extent

The extent of the route.

features Graphic[]

An array of graphics containing the directions.

Autocasts from Object[]

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.

queryGeometry Geometry inherited

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 true and the layer's capabilities.query.supportsQueryGeometry has to be true for the query to return query geometry.

See also:
routeId String

The ID of the route returned from the server.

routeName String

Name specified in RouteParameters.stops.

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

strings Object[]

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.

See also:
totalTime Number

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

See also:

Method Overview

Show inherited methods Hide inherited methods
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 detailsFeatureSet
Objectmore details

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

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

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.