ESM: import DirectionLine from "@arcgis/core/rest/support/DirectionLine.js";
CDN: const DirectionLine = await $arcgis.import("@arcgis/core/rest/support/DirectionLine.js");
Class: @arcgis/core/rest/support/DirectionLine
Since: ArcGIS Maps SDK for JavaScript 4.23
The DirectionLine represents polylines associated with individual direction items.
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.
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
The type of line which is defined by esriDirectionLineType.
Possible Values:"unknown" |"segment" |"maneuver-segment" |"restriction-violation" |"scaled-cost-barrier" |"heavy-traffic" |"slow-traffic" |"moderate-traffic"
Length of the line measured in meters.
Time of the line measured in minutes. Means how much time is required to go along the line.
Polyline representing the direction's location.
Since: ArcGIS Maps SDK for JavaScript 4.30 DirectionLine since 4.23, popupTemplate added at 4.30.
The template for displaying content in a Popup when the graphic is selected.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Since: ArcGIS Maps SDK for JavaScript 4.24 DirectionLine since 4.23, fromGraphic added at 4.24.
Creates a DirectionLine from the parsed Graphic. The method assumes that the graphic's attributes conform to the route layer item schema.
Parameter
optionalA Graphic instance.
Returns
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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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");
}
Inherited
Method removeHandles(groupKey)
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 *
optionalA 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(){Graphic}
Since: ArcGIS Maps SDK for JavaScript 4.24 DirectionLine since 4.23, toGraphic added at 4.24.
Creates a Graphic from the DirectionLine instance. The resulting graphic will have attributes that conform to the route layer item schema.
Returns
Type Description Graphic A Graphic instance.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4