require(["esri/widgets/Zoom/ZoomViewModel"], (ZoomVM) => { /* code goes here */ });
import ZoomVM from "@arcgis/core/widgets/Zoom/ZoomViewModel.js";
esri/widgets/Zoom/ZoomViewModel
Provides the logic for the Zoom widget.
let view = new MapView({
container: "viewDiv",
map: map
});
let zoom = new Zoom({
viewModel: { // autocasts as new ZoomViewModel()
view: view
}
}, "zoomDiv");Constructors
-
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 |
|---|---|---|---|
| Boolean | Indicates if the view can zoom in. | ZoomViewModel | |
| Boolean | Indicates if the view can zoom out. | ZoomViewModel | |
| String | The name of the class. | Accessor | |
| String | The current state of the widget. | ZoomViewModel | |
| MapView|SceneView | The view from which to operate. | ZoomViewModel |
Property Details
-
canZoomIn
PropertycanZoomIn Boolean -
Indicates if the view can zoom in.
-
canZoomOut
PropertycanZoomOut Boolean -
Indicates if the view can zoom out.
-
state
Propertystate Stringreadonly -
The current state of the widget.
Possible Values:"disabled"|"ready"
- Default Value:disabled
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
Zooms the view in by an LOD factor of 0.5. | ZoomViewModel | ||
Zooms the view out by an LOD factor of 2. | ZoomViewModel |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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");