DirectionsFeatureSet | References | ArcGIS Maps SDK for JavaScript

import DirectionsFeatureSet from "@arcgis/core/rest/support/DirectionsFeatureSet.js";

Inheritance:: DirectionsFeatureSet→FeatureSet→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

DirectionsFeatureSet is a subclass of FeatureSet that contains street directions for a solved route.

DirectionsFeatureSet is only returned when a route is solved with an directions output type of "complete", "complete-no-events", "instructions-only", "standard", or "summary-only". The "featuresets" output type returns two regular FeatureSet, one for events, and the other for the path in-between events.

See also

Example

// Get the drive time between Esri and the Redlands Bowl
const apiKey = "<ENTER YOUR API KEY HERE>";
const url = "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World";

const spatialReference = SpatialReference.WebMercator;

const stops = new Collection([
  new Stop({
    name: "Esri",
    geometry: new Point({ x: -13046165, y: 4036335, spatialReference })
  }),
  new Stop({
    name: "Redland Bowl",
    geometry: new Point({ x: -13045111, y: 4036114, spatialReference })
  })
]);

const routeParameters = new RouteParameters({
  apiKey,
  stops,
  outSpatialReference: spatialReference,
  returnDirections: true,
  directionsOutputType: "standard" // default value
});

const { routeResults } = await route.solve(url, routeParameters);
const { directions } = routeResults[0];
console.log(`The total drive time is: ${directions.totalTime}`);

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`DirectionsFeatureSetProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`displayFieldName` inherited	`string`	FeatureSet
`exceededTransferLimit` inherited	`boolean`	FeatureSet
`extent`	`Extent`
`features`	`DirectionsFeature[]`
`fields` inherited	`Field[]`	FeatureSet
`geometryType`	`"polyline"`
`mergedGeometry` readonly	`Polyline \| null`
`queryGeometry` inherited	`GeometryWithoutMeshUnion \| null \| undefined`	FeatureSet
`routeId`	`number \| null \| undefined`
`routeName`	`string \| null \| undefined`
`spatialReference` inherited	`SpatialReference \| null \| undefined`	FeatureSet
`strings` readonly	`DirectionsString[]`
`totalDriveTime`	`number \| null \| undefined`
`totalLength`	`number \| null \| undefined`
`totalTime`	`number \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

displayFieldName

inherited Property

Type: string

Inherited from: FeatureSet

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

inherited Property

Type: boolean

Inherited from: FeatureSet

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.

Default value: false

extent

autocast Property

Type: Extent

The extent of the route.

features

Property

Type: DirectionsFeature[]

An array of direction features. The features are of type DirectionsFeature.

fields

autocast inherited Property

Type: Field[]

Inherited from: FeatureSet

Information about each field.

geometryType

Property

Type: "polyline"

The geometry type of the Directions FeatureSet.

Default value: "polyline"

mergedGeometry

readonly Property

Type: Polyline | null

A single polyline representing the route.

queryGeometry

autocast inherited Property

Type: GeometryWithoutMeshUnion | null | undefined

Inherited from: FeatureSet

The Query.geometry used to query the features. It is useful for getting the buffer geometry generated when querying features by Query.distance or getting the query geometry projected in the Query.outSpatialReference of the query. The query geometry is returned only for client-side queries and hosted feature services. The query's Query.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

Property

Type: number | null | undefined

The ID of the route.

routeName

Property

Type: string | null | undefined

The name of the route.

spatialReference

autocast inherited Property

Type: SpatialReference | null | undefined

Inherited from: FeatureSet

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

readonly Property

Type: DirectionsString[]

A flattened array of all direction strings.

totalDriveTime

Property

Type: number | null | undefined

The total drive time for the route. Temporal units are defined by RouteParameters.directionsTimeAttribute in a route solve request.

totalLength

Property

Type: number | null | undefined

The total length of the route. Length units are defined by RouteParameters.directionsLengthUnits in a route solve request.

See also

RouteParameters.directionsLengthUnits

totalTime

Property

Type: number | null | undefined

The total time for the route including wait and service time. Temporal units are defined by RouteParameters.directionsTimeAttribute in a route solve request.

See also

RouteParameters.directionsTimeAttribute

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.