DirectionPoint | References | ArcGIS Maps SDK for JavaScript

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

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

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`DirectionPointProperties`

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
`arrivalTime`	`Date \| null \| undefined`
`arrivalTimeOffset`	`number \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`directionPointType`	`DirectionPointType \| null \| undefined`
`displayText`	`string \| null \| undefined`
`geometry`	`Point \| null \| undefined`
`popupTemplate`	`PopupTemplate \| null \| undefined`
`sequence`	`number \| null \| undefined`
`type` readonly	`"direction-point"`

arrivalTime

autocast Property

Type: Date | null | undefined

Time when the action happens.

arrivalTimeOffset

Property

Type: number | null | undefined

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

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

directionPointType

Property

Type: DirectionPointType | null | undefined

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

displayText

Property

Type: string | null | undefined

The direction item text to dispay on the screen.

geometry

autocast Property

Type: Point | null | undefined

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

sequence

Property

Type: number | null | undefined

Sequence of the Direction items, starting with 1.

type

readonly Property

Type: "direction-point"

Methods

Method	Signature	Class
`fromGraphic` static	`fromGraphic(graphic: Graphic): DirectionPoint`
`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): DirectionPoint

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

Parameters

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

Returns: DirectionPoint
A DirectionPoint 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 DirectionPoint 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.