import "@arcgis/map-components/components/arcgis-home";Home component is a button that switches the view to its
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 | |
| {
componentLabel?: string | undefined;
title?: string | undefined;
cancel?: string | undefined;
} | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
statereadonly | state | "disabled" | "going-home" | "ready" |
|
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.
messageOverrides
messageOverrides: {
componentLabel?: string | undefined;
title?: string | undefined;
cancel?: string | undefined;
}Replace localized message strings with your own strings.
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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string- Attribute
- reference-element
state
state: "disabled" | "going-home" | "ready"The current state of the component.
- Attribute
- state
- Default value
- "disabled"
viewpoint
viewpoint: ViewpointThe esri/Viewpoint, or point of view, to zoom to when going home. The initial value is determined a few different ways:
If no esri/views/View is provided, the value is null.
If the esri/views/View is ready, but the esri/Viewpoint is not defined, the initial
value of the esri/Viewpoint is determined when the esri/views/View became ready.
If the esri/views/View is ready and the esri/Viewpoint is defined by the user, the initial viewpoint value is the user-defined esri/Viewpoint.
- Default value
- null
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 the view back to the view's initial extent.
- Returns
- Promise<void>
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
go
go(): Promise<void>Animates the view to the initial Viewpoint of the view or the
value of viewpoint
- Returns
- Promise<void>
Events
| Event | Type |
|---|---|
HomeViewModelGoEvent | |
{ name: "state"; } | |
undefined |
arcgisGo
arcgisGo: HomeViewModelGoEventFires when the go() method is called.
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: { name: "state"; }Fired 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: undefinedEvents 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.