require(["esri/widgets/Home/HomeViewModel"], function(HomeVM) { /* code goes here */ });
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:
var 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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The current state of the widget.

more details
more detailsHomeViewModel
MapView | SceneView

The view associated with the widget instance.

more details
more detailsHomeViewModel
Viewpoint

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

more details
more detailsHomeViewModel

Property Details

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

stateStringreadonly

The current state of the widget.

Possible Values: disabled | ready | going-home

Default Value:disabled

The view associated with the widget instance.

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

NameReturn TypeSummaryClass

Emits an event on the instance.

more details
more detailsHomeViewModel

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

more details
more detailsHomeViewModel
Boolean

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

more details
more detailsHomeViewModel
Object

Registers an event handler on the instance.

more details
more detailsHomeViewModel

Method Details

emit(type, event)
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

The event payload.

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:
TypeDescription
BooleanReturns 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.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

Event Overview

NameTypeSummaryClass

Fires when the go() method is called.

more details
more detailsHomeViewModel

Event Details

go

Fires when the go() method is called.

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

API Reference search results

NameTypeModule

There were no match results from your search criteria.