DirectionLine | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: DirectionLine→Accessor

Since: ArcGIS Maps SDK 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.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`DirectionLineProperties`

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
`directionLineType`	`DirectionLineType \| null \| undefined`
`distance`	`number \| null \| undefined`
`duration`	`number \| null \| undefined`
`geometry`	`Polyline \| null \| undefined`
`popupTemplate`	`PopupTemplate \| null \| undefined`
`type` readonly	`"direction-line"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

directionLineType

Property

Type: DirectionLineType | null | undefined

The type of line which is defined by esriDirectionLineType.

distance

Property

Type: number | null | undefined

Length of the line measured in meters.

duration

Property

Type: number | null | undefined

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

geometry

autocast Property

Type: Polyline | null | undefined

Polyline representing the direction's location.

popupTemplate

autocast Property

Type: PopupTemplate | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.30

The template for displaying content in a Popup when the graphic is selected.

type

readonly Property

Type: "direction-line"

Methods

Method	Signature	Class
`fromGraphic` static	`fromGraphic(graphic: Graphic): DirectionLine`
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toGraphic`	`toGraphic(): Graphic`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromGraphic

static Method

Signature: fromGraphic (graphic: Graphic): DirectionLine

Since: ArcGIS Maps SDK 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.

Parameters

Parameter	Type	Description	Required
graphic	`Graphic`	A Graphic instance.

Returns: DirectionLine
A DirectionLine instance.

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.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toGraphic

Method

Signature: toGraphic (): Graphic

Since: ArcGIS Maps SDK 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: Graphic
A Graphic instance.

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.