Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: HomeButton
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/HomeButton"], function(HomeButton) { /* code goes here */ });
Description
(Added at v3.7)
HomeButton provides a simple button to return to the map's default starting extent.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new HomeButton(params, srcNodeRef) | Creates a new HomeButton dijit using the given DOM node. |
CSS
esri/dijit/HomeButton | Download source
| Name | Description |
|---|---|
| home | Class for the home button. |
| homeContainer | Containing class for the widget's node. |
| loading | Class put onto the home button while home extent is loading. |
Properties
| Name | Type | Summary |
|---|---|---|
| extent | Extent | The extent used to zoom to when clicked. |
| loaded | Boolean | Whether the widget has been loaded. |
| map | Map | Map object that this dijit is associated with. |
| theme | String | Class used for styling the widget. |
| visible | Boolean | Whether the widget is visible by default. |
Methods
| Name | Return type | Summary |
|---|---|---|
| destroy() | None | Destroys the widget. |
| hide() | None | Hides the widget. |
| home() | Promise | Goes to the home extent. |
| show() | None | Shows the widget. |
| startup() | None | Finalizes the creation of this dijit. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| home | {
error: < | Fires when the home method has been called. |
| load | Fires when the widget has been loaded. |
Constructor Details
Creates a new HomeButton dijit using the given DOM node.
Parameters:
< |
Required | Various parameters to configure this dijit. See the list below for details. |
< |
Required | Reference or id of a HTML element that this dijit is rendered into. |
params properties: < |
Optional | The extent used to zoom to when clicked. If null will use starting extent. Default value is null. |
< |
Required | Map object that this dijit is associated with. Required. |
< |
Optional | Class used for styling the widget. |
< |
Optional | Whether the widget is visible by default. Default value is true. |
Sample:
var homeButton = new HomeButton({
theme: "HomeButton",
map: map,
extent: null,
visible: true
}, "<dom_id>");
homeButton.startup();Property Details
<Extent
ExtentThe extent used to zoom to when clicked. If
null, it will use starting extent.Default value:
null <Map
MapMap object that this dijit is associated with.
<String
StringClass used for styling the widget.
<Boolean
BooleanWhether the widget is visible by default.
Known values:
true | falseDefault value:
trueMethod Details
Finalizes the creation of this dijit. This method should be called after the constructor for this dijit is called and before letting the users interact with it.
Event Details
[ On Style Events | Connect Style Event ]