Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-home";No specific import is needed for this component.
The Home component is a button that navigates back to the initial Viewpoint or a previously defined viewpoint.
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
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 component's default label.
Property
messageOverrides: Record<string, unknown>
Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
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.
state: "disabled" | "going-home" | "ready"
The current state of the component.
Property
The Viewpoint to go to when going "home". The initial value is determined in a few different ways:
If no referenceElement is provided, the value is null. Once the referenceElement is ready, the initial viewpoint value is the user-defined Viewpoint.
Use dark colors for code blocks Copy
1
2
3
4
5
6
7
8
// Create viewpoint centered on extent of a polygon geometry
let vp = new Viewpoint({
targetGeometry: geom.extent
});
// Sets the Home's viewpoint to that Viewpoint
home.viewpoint = vp;No slots to display.
Events arcgisGoEvent
arcgisGo: HomeViewModelGoEvent
Fires when the go() method is called.
ExampleUse dark colors for code blocks Copy
1
2
3
home.addEventListener("arcgisGo", (event) => {
console.log("updating viewpoint");
});Events 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.
arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
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 cancelGoMethod
cancelGo(): Promise<void>
This function provides the ability to interrupt and cancel the process of navigating back to the initial extent.
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 arcgisHome = document.querySelector("arcgis-home");
document.body.append(arcgisHome);
await arcgisHome.componentOnReady();
console.log("arcgis-home is ready to go!");Method
destroy(): Promise<void>
Permanently destroy the component.
Method
go(): Promise<void>
Animates the map or scene to its initial Viewpoint or the value of viewpoint.
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