DirectionPoint

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

The DirectionPoint represents direction items as points with various display information.

See also:
Example:
// Print driving directions.
const routeLayer = new RouteLayer({
  portalItem: {
    id: "69569b47b1e445b8a42ec12feab41ce9"
  }
});
await routeLayer.load();

const locale = "en-US";
const formatDate = new Intl.DateTimeFormat(locale, {
  year: 'numeric',
  month: 'numeric',
  day: 'numeric',
  hour: 'numeric',
  minute: 'numeric',
  second: 'numeric',
  timeZone: "America/Los_Angeles"
});

for (const directionPoint of routeLayer.directionPoints) {
  const { arrivalTime, displayText } = directionPoint;
  console.log(`${formatDate.format(arrivalTime)}: ${displayText}`);
}

// Output
// 12/7/2020, 3:58:50 PM: Start at Kenoak Pl, Pomona, California, 91768
// 12/7/2020, 3:58:50 PM: Go northeast on Kenoak Pl toward Preciado St
// 12/7/2020, 3:59:15 PM: Turn left on Preciado St
// 12/7/2020, 3:59:26 PM: Turn left on N White Ave
// 12/7/2020, 3:59:37 PM: Turn right onto the ramp and go on I-10 W
// 12/7/2020, 4:02:10 PM: Take the ramp on the right to CA-57 S / CA-57 N toward Santa Ana / I-210
// 12/7/2020, 4:02:24 PM: Keep right at the fork onto CA-57 N toward I-210
// 12/7/2020, 4:06:54 PM: Take the ramp on the right at exit 25B and go on CA-210 E toward San Bernardino

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
Datemore details

Time when the action happens.

more detailsDirectionPoint
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The type of directions event or maneuver described by the point.

more detailsDirectionPoint
Stringmore details

The direction item text to dispay on the screen.

more detailsDirectionPoint
Numbermore details

The local time offset (in minutes) for the arrival time.

more detailsDirectionPoint
Pointmore details

Point representing the direction's location.

more detailsDirectionPoint
Numbermore details

Sequence of the Direction items, starting with 1.

more detailsDirectionPoint
Stringmore details For DirectionPoint the type is always "direction-point". more detailsDirectionPoint

Property Details

arrivalTime Date

Time when the action happens.

declaredClass Stringreadonly inherited

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

directionPointType String

The type of directions event or maneuver described by the point.

Possible Values:"header"|"arrive"|"depart"|"straight"|"on-ferry"|"off-ferry"|"central-fork"|"roundabout"|"u-turn"|"door"|"stairs"|"elevator"|"escalator"|"pedestrian-ramp"|"left-fork"|"left-ramp"|"clockwise-roundabout"|"left-handed-u-turn"|"bear-left"|"left-turn"|"sharp-left"|"left-turn-and-immediate-left-turn"|"left-turn-and-immediate-right-turn"|"right-fork"|"right-ramp"|"counter-clockwise-roundabout"|"right-handed-u-turn"|"bear-right"|"right-turn"|"sharp-right"|"right-turn-and-immediate-left-turn"|"right-turn-and-immediate-right-turn"|"up-elevator"|"up-escalator"|"up-stairs"|"down-elevator"|"down-escalator"|"down-stairs"|"general-event"|"landmark"|"time-zone-change"|"traffic-event"|"scaled-cost-barrier-event"|"boundary-crossing"|"restriction-violation"

displayText String

The direction item text to dispay on the screen.

endTimeOffset Number

The local time offset (in minutes) for the arrival time.

geometry Point

Point representing the direction's location.

sequence Number

Sequence of the Direction items, starting with 1.

type Stringreadonly

For DirectionPoint the type is always "direction-point".

Method Overview

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

Creates a DirectionPoint from the parsed Graphic.

more detailsDirectionPoint
*more details

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

more detailsDirectionPoint
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 DirectionPoint instance.

more detailsDirectionPoint
Objectmore details

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

more detailsDirectionPoint

Method Details

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

Creates a DirectionPoint 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
DirectionPoint A DirectionPoint 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 DirectionPoint 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.