Property Overview

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.

fields Field[]autocast inherited

Autocasts from Object[]

Since: ArcGIS API for JavaScript 4.1

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

Since: ArcGIS API for JavaScript 4.11

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:

• Query.returnQueryGeometry

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:

• RouteParameters.directionsLengthUnits

totalTime Number

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

See also:

• RouteParameters.directionsTimeAttribute

Method Overview

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:

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() topic in the Guide for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.