DirectionLine

AMD: require(["esri/rest/support/DirectionLine"], (DirectionLine) => { /* code goes here */ });
ESM: import DirectionLine from "@arcgis/core/rest/support/DirectionLine";
Class: esri/rest/support/DirectionLine
Inheritance: DirectionLine Accessor
Since: ArcGIS API for JavaScript 4.23

The DirectionLine represents polylines associated with individual direction items.

See also:
Example:
// Print the distance and time between each direction.
const routeLayer = new RouteLayer({
  portalItem: {
    id: "69569b47b1e445b8a42ec12feab41ce9"
  }
});
await routeLayer.load();

const locale = "en-US";
const formatMinutes = new Intl.NumberFormat(locale, {
  minimumFractionDigits: 1,
  maximumFractionDigits: 1
});
const formatDistance = new Intl.NumberFormat(locale, {
  minimumFractionDigits: 0,
  maximumFractionDigits: 0
});

 for (const directionLine of routeLayer.directionLines) {
  const { distance, duration } = directionLine;
  console.log(`Drive ${formatDistance.format(distance)} meters for ${formatMinutes.format(duration)} minutes.`);
}

// Drive 76 meters for 0.4 minutes.
// Drive 77 meters for 0.2 minutes.
// Drive 150 meters for 0.2 minutes.
// Drive 3,670 meters for 2.6 minutes.
// Drive 307 meters for 0.2 minutes.
// Drive 6,293 meters for 4.5 minutes.
// Drive 42,276 meters for 29.2 minutes.
// etc.

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 type of line which is defined by esriDirectionLineType.

more detailsDirectionLine
Numbermore details

Length of the line measured in meters.

more detailsDirectionLine
Numbermore details

Time of the line measured in minutes.

more detailsDirectionLine
Polylinemore details

Polyline representing the direction's location.

more detailsDirectionLine
Stringmore details For DirectionLine the type is always "direction-line". more detailsDirectionLine

Property Details

declaredClass Stringreadonly inherited

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

directionLineType String

The type of line which is defined by esriDirectionLineType.

Possible Values:"unknown"|"segment"|"maneuver-segment"|"restriction-violation"|"scaled-cost-barrier"|"heavy-traffic"|"slow-traffic"|"moderate-traffic"

distance Number

Length of the line measured in meters.

duration Number

Time of the line measured in minutes. Means how much time is required to go along the line.

geometry Polyline

Polyline representing the direction's location.

type Stringreadonly

For DirectionLine the type is always "direction-line".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
DirectionLinemore details

Creates a DirectionLine from the parsed Graphic.

more detailsDirectionLine
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsDirectionLine
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor
Graphicmore details

Creates a Graphic from the DirectionLine instance.

more detailsDirectionLine
Objectmore details

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

more detailsDirectionLine

Method Details

fromGraphic(graphic){DirectionLine}static
Since: ArcGIS API for JavaScript 4.24

Creates a DirectionLine from the parsed Graphic. The method assumes that the graphic's attributes conform to the route layer item schema.

Parameter:
graphic Graphic
optional

A Graphic instance.

Returns:
Type Description
DirectionLine A DirectionLine instance.
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.
own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

toGraphic(){Graphic}
Since: ArcGIS API for JavaScript 4.24

Creates a Graphic from the DirectionLine instance. The resulting graphic will have attributes that conform to the route layer item schema.

Returns:
Type Description
Graphic A Graphic instance.
toJSON(){Object}

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.