Provides the logic for the Home widget that animates the View to its initial Viewpoint or a previously defined viewpoint.
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)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
GoToOverride | This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. more details | HomeViewModel | |
String | The current state of the widget. more details | HomeViewModel | |
MapView|SceneView | The view associated with the widget instance. more details | HomeViewModel | |
Viewpoint | The Viewpoint, or point of view, to zoom to when going home. more details | HomeViewModel |
Property Details
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
goToOverride GoToOverrideSince: ArcGIS Maps SDK for JavaScript 4.8
-
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
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.
-
The Viewpoint, or point of view, to zoom to when going home. The initial value is determined a few different ways:
- 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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
This function provides the ability to interrupt and cancel the process of navigating the view back to the view's initial extent. more details | HomeViewModel | ||
Boolean | Emits an event on the instance. more details | HomeViewModel | |
Animates the view to the initial Viewpoint of the view or the value of viewpoint. more details | HomeViewModel | ||
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | HomeViewModel | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Object | Registers an event handler on the instance. more details | HomeViewModel | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
cancelGo()Since: ArcGIS Maps SDK 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 Maps SDK for JavaScript 4.5
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameterstype StringThe name of the event.
event ObjectoptionalThe event payload.
ReturnsType Description Boolean true
if a listener was notified
-
go()
-
-
hasEventListener(type){Boolean}
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
on(type, listener){Object}
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersAn event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
ReturnsType 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. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
Fires when the go() method is called. more details |
HomeViewModel |