Home

Use dark colors for code blocksCopy
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
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`goToOverride`		`(((view: MapView \| SceneView, goToParameters: GoToParameters) => void))`
`icon`	`icon`	`string`
`label`	`label`	`string`
`messageOverrides`		`{ componentLabel?: string \| undefined; title?: string \| undefined; cancel?: string \| undefined; }`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`state` readonly	`state`	`"disabled" \| "going-home" \| "ready"`
`viewpoint`		`Viewpoint`

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.

icon

Property

icon: string

Icon displayed in the component's button.

Attribute: icon
Default value: "home"

label

Property

label: string

The component's default label.

Attribute: label

messageOverrides

Property

messageOverrides: {
    componentLabel?: string | undefined;
    title?: string | undefined;
    cancel?: string | undefined;
}

Replace localized message strings with your own strings.

position

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

referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string

Attribute: reference-element

state

readonly

Property

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

The current state of the component.

Attribute: state
Default value: "disabled"

viewpoint

Property

viewpoint: Viewpoint

The 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`	`cancelGo(): Promise<void>`
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`
`go`	`go(): Promise<void>`

cancelGo

Method

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

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

go

Method

go(): Promise<void>

Animates the view to the initial Viewpoint of the view or the value of viewpoint

Returns: Promise<void>

Events

Event	Type
`arcgisGo`	`HomeViewModelGoEvent`
`arcgisPropertyChange`	`{ name: "state"; }`
`arcgisReady`	`undefined`

arcgisGo

Event

arcgisGo: HomeViewModelGoEvent

Fires when the go() method is called.

arcgisPropertyChange

Event

arcgisPropertyChange: { name: "state"; }

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

arcgisReady

Event

arcgisReady: undefined

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