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
-
new ZoomViewModel(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 |
---|---|---|---|
Boolean | Indicates if the view can zoom in. more details | ZoomViewModel | |
Boolean | Indicates if the view can zoom out. more details | ZoomViewModel | |
String | The name of the class. more details | Accessor | |
String | The current state of the widget. more details | ZoomViewModel | |
MapView|SceneView | The view from which to operate. more details | ZoomViewModel |
Property Details
-
canZoomIn Boolean
-
Indicates if the view can zoom in.
-
canZoomOut Boolean
-
Indicates if the view can zoom out.
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
state Stringreadonly
-
The current state of the widget.
Possible Values:"disabled"|"ready"
- Default Value:disabled
-
The view from which to operate.
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 | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Zooms the view in by an LOD factor of 0.5. more details | ZoomViewModel | ||
Zooms the view out by an LOD factor of 2. more details | ZoomViewModel |
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.
-
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"); }
-
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");
-
zoomIn()
-
Zooms the view in by an LOD factor of 0.5.
-
zoomOut()
-
Zooms the view out by an LOD factor of 2.