import "@arcgis/map-components/components/arcgis-home";
The Home component is a button that navigates back to the
initial Viewpoint
or a previously defined viewpoint
.
Demo
Properties
Property | Attribute | Type |
---|---|---|
auto-destroy-disabled | boolean | |
| (((view: MapView | SceneView, goToParameters: GoToParameters) => void)) | |
icon | string | |
label | string | |
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
state readonly | state | "disabled" | "going-home" | "ready" |
|
autoDestroyDisabled
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
goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
icon
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
- "home"
messageOverrides
messageOverrides: Record<string, unknown>
Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
- Attribute
- position
- Default value
- "top-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string
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.
- Attribute
- reference-element
state
state: "disabled" | "going-home" | "ready"
The current state of the component.
- Attribute
- state
- Default value
- "disabled"
viewpoint
viewpoint: Viewpoint
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.
Example
// 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;
- Default value
- null
Slots
Events
Event | Type |
---|---|
HomeViewModelGoEvent | |
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> |
arcgisGo
arcgisGo: HomeViewModelGoEvent
Fires when the go() method is called.
Example
home.addEventListener("arcgisGo", (event) => {
console.log("updating viewpoint");
});
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.
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
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 |
---|---|
cancelGo(): Promise<void> | |
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
go(): Promise<void> |
cancelGo
cancelGo(): Promise<void>
This function provides the ability to interrupt and cancel the process of navigating back to the initial extent.
- Returns
- Promise<void>
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
Example
const arcgisHome = document.querySelector("arcgis-home");
document.body.append(arcgisHome);
await arcgisHome.componentOnReady();
console.log("arcgis-home is ready to go!");
- Returns
- Promise<void>