Home

require(["esri/widgets/Home"], function(Home) { /* code goes here */ });

Class: esri/widgets/Home

Inheritance: Home Widget Accessor

Since: ArcGIS API for JavaScript 4.0

Provides a simple widget that switches the View to its initial Viewpoint or a previously defined viewpoint. By default this button looks like the following:

home-button

You can use the view's DefaultUI to add widgets to the view's user interface via the ui property on the view. See the example below.

For information about gaining full control of widget styles, see the Styling topic.

See also:

Example:

var homeWidget = new Home({
  view: view
});

// adds the home widget to the top left corner of the MapView
view.ui.add(homeWidget, "top-left");

Constructors

new Home(properties)

Parameter:

properties Object

optional

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

Example:

// typical usage
var homeButton = new Home({
  view: view,
  viewpoint: new Viewpoint()
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties Hide inherited properties

Type	Summary	Class
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	more details	Widget
String	The name of the class. more details	more details	Accessor
Boolean	When `true`, this property indicates whether the widget has been destroyed. more details	more details	Widget
GoToOverride	This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. more details	more details	Home
String	The widget's default CSS icon class. more details	more details	Home
String	The unique ID assigned to the widget when the widget is created. more details	more details	Widget
String	The widget's default label. more details	more details	Home
MapView\|SceneView	A reference to the MapView or SceneView. more details	more details	Home
HomeViewModel	The view model for this widget. more details	more details	Home
Viewpoint	The Viewpoint, or point of view, to zoom to when going home. more details	more details	Home

Property Details

container String|HTMLElement inherited

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

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.

destroyed Boolean inherited

When true, this property indicates whether the widget has been destroyed.

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);
};

iconClass String Since: ArcGIS API for JavaScript 4.7

The widget's default CSS icon class.

id String inherited

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String Since: ArcGIS API for JavaScript 4.7

The widget's default label.

view MapView|SceneView

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

viewModel HomeViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the HomeViewModel class to access all properties and methods on the widget.

viewpoint Viewpoint

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
var vp = new Viewpoint({
  targetGeometry: geom.extent
});

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

Method Overview

Show inherited methods Hide inherited methods

Return Type	Summary	Class
	This function provides the ability to interrupt and cancel the process of navigating the view back to the view's initial extent. more details	more details	Home
String	A utility method used for building the value for a widget's `class` property. more details	more details	Widget
	Destroys the widget instance. more details	more details	Widget
Boolean	Emits an event on the instance. more details	more details	Widget
	Animates the view to the initial Viewpoint of the view or the value of viewpoint. more details	more details	Home
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name. more details	more details	Widget
Object	Registers an event handler on the instance. more details	more details	Widget
	Widget teardown helper. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
Object	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	Renders widget to the DOM immediately. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget

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.

classes(classNames){String}inherited Since: ArcGIS API for JavaScript 4.7

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:

classNames Array<(string|Array<string>|Object)>

repeatable

The class names.

Returns:

Type	Description
String	The computed class name.

See also:

Guide - Widget development (rendering)

Example:

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited 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.

See also:

Event: go

hasEventListener(type){Boolean}inherited

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}inherited

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

Parameters:

type String|String []

A event type, or an array of event types, 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(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);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

Event Overview

Name	Type	Summary	Class
		Fires when the go() method is called. more details	more details	Home

Event Details

go

Fires when the go() method is called.

See also:

go()

Example:

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

	Site wide shortcuts
`?`	Bring up this help dialog
`esc`	Dismiss this help dialog
`gh`	Go to Home
`gg`	Go to Guide
`ga`	Go to API Reference
`gs`	Go to Sample Code
`gt`	Scroll to top of page
`spacebar`	Scroll page down
`shift spacebar`	Scroll page up
`gb`	Scroll to bottom of page

	API Reference
`/`	Focus search
`esc`	Remove search focus
`enter`	Focus first search result
`c`	Go to Constructors
`p`	Go to Properties
`m`	Go to Methods
`t`	Go to Type definitions
`e`	Go to Events

JavaScript API 4.14 API Reference

JavaScript API API Reference

Home

Home

Constructors

Property Overview

Property Details

Method Overview

Method Details

Event Overview

Event Details

JavaScript API 4.14 API Reference

JavaScript API API Reference

Constructors

Property Overview

Property Details

Method Overview

Method Details

Event Overview

Event Details

API Reference search results