import "@arcgis/map-components/components/arcgis-directions";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
| Property | Attribute | Type |
|---|---|---|
api-key | string | |
auto-destroy-disabled | boolean | |
| (((view: MapView | SceneView, goToParameters: GoToParameters) => void)) | |
heading-level | number | |
hide-layer-details | boolean | |
hide-save-as-button | boolean | |
hide-save-button | boolean | |
icon | string | |
label | string | |
lastRoutereadonly | | DirectionsLastRoute |
| ||
max-stops | number | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
route-layer-item-id | string | |
| ||
statereadonly | state | "disabled" | "error" | "initializing" | "ready" | "routing" | "unauthenticated" |
unit | "centimeters" | "decimeters" | "feet" | "imperial" | "inches" | "kilometers" | "meters" | "metric" | "miles" | "millimeters" | "nautical-miles" | "us-feet" | "yards" | |
use-default-route-layer | boolean |
apiKey
apiKey: stringAn authorization string used to access a resource or service.
- Attribute
- api-key
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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.
- Attribute
- auto-destroy-disabled
- Default value
- false
goToOverride
goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
headingLevel
headingLevel: numberIndicates the heading level to use for the origin and destination addresses (i.e.
- Attribute
- heading-level
- Default value
- 2
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "right"
lastRoute
lastRoute: DirectionsLastRouteThe most recent route result.
- Default value
- null
maxStops
maxStops: numberThe maximum number of stops allowed for routing.
- Attribute
- max-stops
- Default value
- 50
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "bottom-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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.
- Attribute
- reference-element
searchProperties
searchProperties: DirectionsSearchPropertiesControls the default properties used when searching.
- Default value
- null
state
state: "disabled" | "error" | "initializing" | "ready" | "routing" | "unauthenticated"The current state of the component.
- Attribute
- state
- Default value
- "disabled"
unit
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.
- Attribute
- unit
useDefaultRouteLayer
useDefaultRouteLayer: boolean- Attribute
- use-default-route-layer
- Default value
- false
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state" | "lastRoute"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state" | "lastRoute"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
getDirections(): Promise<__esri.RouteLayerSolveResult> | |
save(): Promise<__esri.PortalItem> | |
saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem> | |
zoomToRoute(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisDirections = document.querySelector("arcgis-directions");
document.body.append(arcgisDirections);
await arcgisDirections.componentOnReady();
console.log("arcgis-directions is ready to go!");- Returns
- Promise<void>
getDirections
getDirections(): Promise<__esri.RouteLayerSolveResult>- Returns
- Promise<RouteLayerSolveResult>
saveAs
saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>Parameters
| Parameter | Type | Optional? |
|---|---|---|
portalItem | ||
options | { folder: PortalFolder; } |
- Returns
- Promise<PortalItem>