A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directions/ below:

Directions | ArcGIS Maps SDK for JavaScript 4.33

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 apiKey

Property

apiKey: string

An authorization string used to access a resource or service.

Read more...

Attribute
api-key
autoDestroyDisabled

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.

Attribute
auto-destroy-disabled
Default value
false
goToOverride

Property

goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

Read more...

headingLevel

Property

headingLevel: number

Indicates the heading level to use for the origin and destination addresses (i.e.

Attribute
heading-level
Default value
2
hideLayerDetails

Property

hideLayerDetails: boolean

Attribute
hide-layer-details
Default value
false
hideSaveAsButton

Property

hideSaveAsButton: boolean

Attribute
hide-save-as-button
Default value
false
hideSaveButton

Property

hideSaveButton: boolean

Attribute
hide-save-button
Default value
false
icon

Property

icon: string

Icon 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"
label

Property

label: string

The widget's default label.

Read more...

Attribute
label
lastRoute

readonlyProperty

lastRoute: DirectionsLastRoute

The most recent route result.

Read more...

Default value
null
layer

Property

The RouteLayer associated with the Directions widget.

Read more...

maxStops

Property

maxStops: number

The maximum number of stops allowed for routing.

Attribute
max-stops
Default value
50
position

Property

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

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.

See also
Attribute
reference-element
routeLayerItemId

Property

routeLayerItemId: string

Attribute
route-layer-item-id
searchProperties

Property

Controls 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

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.

Read more...

Attribute
unit
useDefaultRouteLayer

Property

useDefaultRouteLayer: boolean

Attribute
use-default-route-layer
Default value
false
Slots

No slots to display.

Events arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state" | "lastRoute"; }>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

arcgisReady

Event

arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is is ready to be interacted with.

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

Methods Method Signature componentOnReady

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>

componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Example

Use 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!");
Returns
Promise<void>
destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns
Promise<void>
getDirections

Method

getDirections(): Promise<__esri.RouteLayerSolveResult>

Returns
Promise<RouteLayerSolveResult>
save

Method

save(): Promise<__esri.PortalItem>

Returns
Promise<PortalItem>
saveAs

Method

saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>

Parameters Parameter Type Optional?

portalItem

PortalItem

options

{ folder: PortalFolder; }

Returns
Promise<PortalItem>
zoomToRoute

Method

zoomToRoute(): Promise<void>

Returns
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