Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-directions";
No specific import is needed for this component.
The Directions component provides a way to calculate directions, between two or more input locations with a RouteLayer, using ArcGIS Online and custom Network Analysis Route services.
Demo Properties apiKeyProperty
apiKey: string
An authorization string used to access a resource or service.
Property
autoDestroyDisabled: boolean
If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.
Property
goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
Property
headingLevel: number
Indicates the heading level to use for the origin and destination addresses (i.e.
Property
hideLayerDetails: boolean
Property
hideSaveAsButton: boolean
Property
hideSaveButton: boolean
Property
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
Property
label: string
The widget's default label.
readonlyProperty
lastRoute: DirectionsLastRoute
The most recent route result.
Property
The RouteLayer associated with the Directions widget.
Property
maxStops: number
The maximum number of stops allowed for routing.
Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
By assigning the id
attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
Property
routeLayerItemId: string
Property
Controls the default properties used when searching.
state: "disabled" | "error" | "initializing" | "ready" | "routing" | "unauthenticated"
The current state of the component.
Property
unit: "centimeters" | "decimeters" | "feet" | "imperial" | "inches" | "kilometers" | "meters" | "metric" | "miles" | "millimeters" | "nautical-miles" | "us-feet" | "yards"
Unit system (imperial, metric) or specific unit used for displaying the distance values.
Property
useDefaultRouteLayer: boolean
No slots to display.
Events arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state" | "lastRoute"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods Method SignaturecomponentOnReady
componentOnReady(): Promise<void>
destroy
destroy(): Promise<void>
getDirections
getDirections(): Promise<__esri.RouteLayerSolveResult>
save
save(): Promise<__esri.PortalItem>
saveAs
saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>
zoomToRoute
zoomToRoute(): Promise<void>
Method
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
const arcgisDirections = document.querySelector("arcgis-directions");
document.body.append(arcgisDirections);
await arcgisDirections.componentOnReady();
console.log("arcgis-directions is ready to go!");
Method
destroy(): Promise<void>
Permanently destroy the component.
Method
getDirections(): Promise<__esri.RouteLayerSolveResult>
Method
save(): Promise<__esri.PortalItem>
Method
saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>
portalItem
PortalItem
options
{ folder: PortalFolder; }
Method
zoomToRoute(): Promise<void>
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