ZoomViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Provides the logic for the Zoom widget.

See also

Example

let view = new MapView({
  container: "viewDiv",
  map: map
});

let zoom = new Zoom({
  viewModel: {  // autocasts as new ZoomViewModel()
    view: view
  }
}, "zoomDiv");

Constructors

ZoomViewModel Constructor new ZoomViewModel(properties)

Parameter

properties Object

optional

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

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
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 Property canZoomIn Boolean

Indicates if the view can zoom in.

canZoomOut Property canZoomOut Boolean

Indicates if the view can zoom out.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

state Property state Stringreadonly

The current state of the widget.

Possible Values:"disabled" |"ready"

Default Value:"disabled"

view Property view MapView |SceneView

The view from which to operate.

Method Overview

Show inherited methods

Hide inherited methods

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

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

zoomIn Method zoomIn()

Zooms the view in by an LOD factor of 0.5.

zoomOut Method zoomOut()

Zooms the view out by an LOD factor of 2.