Stop | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: Stop→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.23

A stop respresents the start, end, or midpoint of a route in RouteLayer.stops or RouteParameters.stops.

See also

Example

// Display the route name and overall distance and duration.
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 stop of routeLayer.stops) {
   const { arriveTime, departTime, name, locationType } = stop;
   console.log(`Stop:           ${locationType} at ${name}`);
   console.log(`Arrival Time:   ${formatDate.format(arriveTime)}`);
   console.log(`Departure Time: ${formatDate.format(departTime)}`);
 }

 // Stop:           stop at Kenoak Pl, Pomona, California, 91768
 // Arrival Time:   12/7/2020, 3:58:50 PM
 // Departure Time: 12/7/2020, 3:58:50 PM
 // Stop:           stop at 173 E Arbeth St, Rialto, California, 92377
 // Arrival Time:   12/7/2020, 4:38:29 PM
 // Departure Time: 12/7/2020, 4:38:29 PM
 // etc

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`StopProperties`

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
`arriveTime`	`Date \| null \| undefined`
`arriveTimeOffset`	`number \| null \| undefined`
`curbApproach`	`CurbApproach \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`departTime`	`Date \| null \| undefined`
`departTimeOffset`	`number \| null \| undefined`
`geometry`	`Point \| null \| undefined`
`locationType`	`LocationType \| null \| undefined`
`name`	`string \| null \| undefined`
`popupTemplate`	`PopupTemplate \| null \| undefined`
`sequence`	`number \| null \| undefined`
`snapX`	`number \| null \| undefined`
`snapY`	`number \| null \| undefined`
`snapZ`	`number \| null \| undefined`
`status`	`Status \| null \| undefined`
`timeWindowEnd`	`Date \| null \| undefined`
`timeWindowStart`	`Date \| null \| undefined`
`type` readonly	`"stop"`

arriveTime

autocast Property

Type: Date | null | undefined

The date and time value indicating the arrival time at the stop.

arriveTimeOffset

Property

Type: number | null | undefined

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

curbApproach

Property

Type: CurbApproach | null | undefined

Specify the direction a vehicle may arrive at and depart from the stop.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

departTime

autocast Property

Type: Date | null | undefined

The date and time value indicating the departure time from the stop.

departTimeOffset

Property

Type: number | null | undefined

The local time offset in minutes for the departure time.

geometry

autocast Property

Type: Point | null | undefined

The point location of the stop.

locationType

Property

Type: LocationType | null | undefined

name

Property

Type: string | null | undefined

The name of the stop. The name is used in the driving directions. If the name is not specified, a unique name prefixed with Location is automatically generated in the output stops, routes, and directions.

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

If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify with this attribute. In a group of stops that have the same RouteName value, the sequence number should be greater than 0 but not greater than the total number of stops. Also, the sequence number should not be duplicated.

snapX

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

snapY

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

snapZ

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The snapZ field is 0 if the network is two dimensional.

status

Property

Type: Status | null | undefined

Indicates the status of the point with respect to its location on the network and the outcome of the analysis.

timeWindowEnd

autocast Property

Type: Date | null | undefined

The latest time the route can visit the stop. The values for this field are copied from the TimeWindowEnd field on the input stops.

timeWindowStart

autocast Property

Type: Date | null | undefined

The earliest time the route can visit the stop. The values for this field are copied from the TimeWindowStart field on the input stops.

type

readonly Property

Type: "stop"

Methods

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

Since: ArcGIS Maps SDK for JavaScript 4.24

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