HomeViewModel

AMD: require(["esri/widgets/Home/HomeViewModel"], (HomeVM) => { /* code goes here */ });
ESM: import HomeVM from "@arcgis/core/widgets/Home/HomeViewModel";
Class: esri/widgets/Home/HomeViewModel
Inheritance: HomeViewModel Accessor
Since: ArcGIS API 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:
Example:
let homeWidget = new Home({
  viewModel: {  // autocasts as new HomeViewModel()
    view: view
  }
}, "homediv");  // References the DOM node used to place the widget

Constructors

new HomeViewModel(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
GoToOverridemore details

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

more detailsHomeViewModel
Stringmore details

The current state of the widget.

more detailsHomeViewModel
MapView|SceneViewmore details

The view associated with the widget instance.

more detailsHomeViewModel
Viewpointmore details

The Viewpoint, or point of view, to zoom to when going home.

more detailsHomeViewModel

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

goToOverride GoToOverride
Since: ArcGIS API 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 the Search widget 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 Stringreadonly

The current state of the widget.

Possible Values:"disabled"|"ready"|"going-home"

Default Value:disabled

The view associated with the widget instance.

viewpoint Viewpointautocast

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.
Default Value:null
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;

Method Overview

Name Return Type Summary Class
more details

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

more detailsHomeViewModel
Booleanmore details

Emits an event on the instance.

more detailsHomeViewModel
more details

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

more detailsHomeViewModel
Booleanmore details

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

more detailsHomeViewModel
Objectmore details

Registers an event handler on the instance.

more detailsHomeViewModel

Method Details

cancelGo()
Since: ArcGIS API 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.

emit(type, event){Boolean}
Since: ArcGIS API for JavaScript 4.5

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

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
Type Description
Boolean true if a listener was notified
go()

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

hasEventListener(type){Boolean}

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

Parameter:
type String

The name of the event.

Returns:
Type Description
Boolean Returns true if the class supports the input event.
on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of supported events.

Parameters:

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:
Type Description
Object 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);
});

Event Overview

Name Type Summary Class
more details

Fires when the go() method is called.

more details HomeViewModel

Event Details

go

Fires when the go() method is called.

See also:
Example:
homeWidget.viewModel.on("go", function(event){
  console.log("updating viewpoint");
});

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