Home

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

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

Read more...

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"home"

The component's default label.

Attribute

label

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

Attribute

position

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

• Associate components with a Map or Scene component

Attribute

reference-element

The current state of the component.

Attribute

state

Default value

"disabled"

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Home component will be associated with a map or scene component rather than using the view 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.

Example

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

This function provides the ability to interrupt and cancel the process of navigating back to the initial extent.

Returns

Promise<void>

Create a promise that resolves once component is fully loaded.

Example

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>

Permanently destroy the component.

Returns

Promise<void>

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

Returns

Promise<void>

Fires when the go() method is called.

Example

1
2
3
home.addEventListener("arcgisGo", (event) => {
  console.log("updating viewpoint");
});

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

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