HomeViewModel | References | ArcGIS Maps SDK for JavaScript

import HomeViewModel from "@arcgis/core/widgets/Home/HomeViewModel.js";

const HomeViewModel = await $arcgis.import("@arcgis/core/widgets/Home/HomeViewModel.js");

Inheritance: HomeViewModel→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

Provides the logic for the Home widget that animates the View to its initial Viewpoint or a previously defined viewpoint.

See also

Home component
Home widget - Deprecated since 4.32. Use the Home component instead.
Programming patterns: Widget viewModel pattern

Example

let homeWidget = new Home({
  viewModel: {  // autocasts as new HomeViewModel()
    view: view
  }
}, "homediv");  // References the DOM node used to place the widget

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	HomeViewModelProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
goToOverride inherited	GoToOverride \| null \| undefined	GoTo
state readonly	HomeViewModelState
view	MapViewOrSceneView \| null \| undefined
viewpoint	Viewpoint \| null \| undefined

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

goToOverride

inherited Property

Type: GoToOverride | null | undefined

Inherited from: GoTo

Since: ArcGIS Maps SDK for JavaScript 4.8

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

See also

Example

// The following snippet uses Search but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options = {
    duration: updatedDuration
  };
  return view.goTo(goToParams.target, goToParams.options);
};

state

readonly Property

Type: HomeViewModelState

The current state of the widget.

Default value: "disabled"

view

Property

Type: MapViewOrSceneView | null | undefined

The view associated with the widget instance.

viewpoint

autocast Property

Type: Viewpoint | null | undefined

The Viewpoint, or point of view, to zoom to when going home. The initial value is determined a few different ways:

If no View is provided, the value is null.
If the View is ready, but the Viewpoint is not defined, the initial value of the Viewpoint is determined when the View became ready.
If the View is ready and the Viewpoint is defined by the user, the initial viewpoint value is the user-defined Viewpoint.

Example

// Creates a viewpoint centered on the extent of a polygon geometry
let vp = new Viewpoint({
  targetGeometry: geom.extent
});

// Sets the model's viewpoint to the Viewpoint based on a polygon geometry
home.ViewModel.viewpoint = vp;

Methods

Method	Signature	Class
cancelGo	cancelGo(): void
emit inherited	emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean	EventedMixin
go	go(): Promise<void>
hasEventListener inherited	hasEventListener<Type extends EventNames<this>>(type: Type): boolean	EventedMixin
on inherited	on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle	EventedMixin

cancelGo

Method

Signature: cancelGo (): void

Since: ArcGIS Maps SDK for JavaScript 4.9

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

Returns: void

emit

inherited Method

Signature: emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Since: ArcGIS Maps SDK for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

Parameter	Type	Description	Required
type	Type	The name of the event.
event	this["@eventTypes"][Type]	The event payload.

Returns: boolean
true if a listener was notified

go

Method

Signature: go (): Promise<void>

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

Returns: Promise<void>

hasEventListener

inherited Method

Signature: hasEventListener <Type extends EventNames<this>>(type: Type): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameters

Parameter	Type	Description	Required
type	Type	The name of the event.

Returns: boolean
Returns true if the class supports the input event.

on

inherited Method

Signature: on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

Parameter	Type	Description	Required
type	Type	An event or an array of events to listen for.
listener	EventedCallback<this["@eventTypes"][Type]>	The function to call when the event fires.

Returns

ResourceHandle

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

Events

Name	Type
go	CustomEvent<void>

go

Event

go: CustomEvent<void>

Fires when the Home.go() method is called.

See also

Home.go()

Example

homeWidget.on("go", function(event){
  console.log("updating viewpoint");
});

Type definitions

HomeViewModelState

Type definition

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