DirectionPoint

AMD: require(["esri/rest/support/DirectionPoint"], (DirectionPoint) => { /* code goes here */ });
ESM: import DirectionPoint from "@arcgis/core/rest/support/DirectionPoint.js";
Class: esri/rest/support/DirectionPoint
Inheritance: DirectionPoint Accessor
Since: ArcGIS Maps SDK 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

Time when the action happens.

DirectionPoint

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

DirectionPoint

The name of the class.

Accessor

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

DirectionPoint

The direction item text to dispay on the screen.

DirectionPoint

Point representing the direction's location.

DirectionPoint

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

DirectionPoint

Sequence of the Direction items, starting with 1.

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

Property Details

arrivalTime

Property
arrivalTime Date

Time when the action happens.

arrivalTimeOffset

Property
arrivalTimeOffset Number

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

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

directionPointType

Property
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" |"lane" |"time-zone-change" |"traffic-event" |"scaled-cost-barrier-event" |"boundary-crossing" |"restriction-violation"

displayText

Property
displayText String

The direction item text to dispay on the screen.

geometry

Property
geometry Point

Point representing the direction's location.

popupTemplate

Property
popupTemplate PopupTemplateautocast
Since: ArcGIS Maps SDK for JavaScript 4.30 DirectionPoint since 4.23, popupTemplate added at 4.30.

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

sequence

Property
sequence Number

Sequence of the Direction items, starting with 1.

type

Property
type Stringreadonly

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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

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

Accessor

Creates a DirectionPoint from the parsed Graphic.

DirectionPoint
*

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

DirectionPoint

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Creates a Graphic from the DirectionPoint instance.

DirectionPoint

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

DirectionPoint

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromGraphic

Method
fromGraphic(graphic){DirectionPoint}static
Since: ArcGIS Maps SDK for JavaScript 4.24 DirectionPoint since 4.23, fromGraphic added at 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

Method
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.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toGraphic

Method
toGraphic(){Graphic}
Since: ArcGIS Maps SDK for JavaScript 4.24 DirectionPoint since 4.23, toGraphic added at 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

Method
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.