Home

ESM:
Use dark colors for code blocksCopy
1
import "@arcgis/map-components/components/arcgis-home";
CDN:
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.

Demo

Properties

PropertyAttributeType
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

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...

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
"home"

label

Property
label: string

The component's default label.

Attribute
label

messageOverrides

Property
messageOverrides: Record<string, unknown>

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

position

reflected

Attribute changes are reflected on the DOM.

Property
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

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

state

readonlyreflected

Attribute changes are reflected on the DOM.

Property
state: "disabled" | "going-home" | "ready"

The current state of the component.

Attribute
state
Default value
"disabled"

viewpoint

Property
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
Use dark colors for code blocksCopy
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;
Default value
null

Slots

No slots to display.

Events

EventType
HomeViewModelGoEvent
CustomEvent<{ name: "state"; }>

arcgisGo

Event
arcgisGo: HomeViewModelGoEvent

Fires when the go() method is called.

Example
Use dark colors for code blocksCopy
1
2
3
home.addEventListener("arcgisGo", (event) => {
  console.log("updating viewpoint");
});
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.

arcgisPropertyChange

Event
arcgisPropertyChange: CustomEvent<{ name: "state"; }>

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

MethodSignature
cancelGo(): Promise<void>
componentOnReady(): Promise<void>
destroy(): Promise<void>
go(): Promise<void>

cancelGo

Method
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

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Example
Use dark colors for code blocksCopy
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!");
Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component.

Returns
Promise<void>

go

Method
go(): Promise<void>

Animates the map or scene to its initial Viewpoint or the value of viewpoint.

Returns
Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.