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

Property Overview

Property Details

declaredClassStringreadonly

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

viewMapView|SceneView

The view associated with the widget instance.

viewpointViewpoint

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

Method Details

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 listened events.

Parameters:

type String The name of event to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

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