Navigation

Property Overview

Property Details

browserTouchPanEnabled Boolean

Since: ArcGIS API for JavaScript 4.14

Indicates if single finger touch drag events are enabled or disabled. When false, the map cannot be panned with single finger touch gesture on touch devices. This will allow web pages to scroll down without panning the map on touch devices. While single touch panning and zooming is disabled, the map can still be panned, zoomed, and rotated (if unconstrained) with two fingers. This property does not affect mouse-based dragging.

Default Value:true

Example

// Disable single touch panning in a MapView.
const view = new MapView({
  container: "viewDiv",
  map: new Map({
    basemap: "streets-vector"
  })
});
view.navigation.browserTouchPanEnabled = false;

declaredClass Stringreadonly inherited

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

gamepad GamepadSettings

Gamepad navigation specific configuration settings.

Example

// Disable the gamepad usage in MapView
const view = new MapView({
  container: "viewDiv",
  map: new Map({
    basemap: "satellite"
  }),
  center: [176.185, -37.643],
  zoom: 13,
  navigation: {
    gamepad: {
      enabled: false
    }
  }
});

// Disable gamepad usage in SceneView.
const view = new SceneView({
  container: "viewDiv",
  map: new Map({
    basemap: "satellite",
    ground: "world-elevation"
  }),
  camera: {
    position: [176.171, -37.660, 2000],
    heading: 0,
    tilt: 60
  },
  navigation: {
    gamepad: {
      enabled: false
    }
  }
});

momentumEnabled Boolean

Since: ArcGIS API for JavaScript 4.14

When true, the view will temporarily continue to pan after the pointer (e.g. mouse, stylus, finger) has lifted.

Default Value:true

Example

// Disable pan animation in the MapView.
const view = new MapView({
  container: "viewDiv",
  map: new Map({
    basemap: "streets-vector"
  })
});
view.navigation.momentumEnabled = false;

mouseWheelZoomEnabled Boolean

Since: ArcGIS API for JavaScript 4.14

Indicates whether the view can be zoomed in or out with the mouse wheel. When a map occupies part the screen, page navigation may be difficult at times since mouse wheel movement over the map can be interpreted as map zooming rather than page scrolling. In some cases, setting mouseWheelZoomEnabled to false can make scrollable webpages with maps easier to navigate.

Default Value:true

Example

// To disable mouse wheel zooming in a MapView.
const view = new MapView({
  container: "viewDiv",
  map: new Map({
    basemap: "streets-vector"
  })
});
view.navigation.mouseWheelZoomEnabled = false;

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

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(groupKey){Boolean}inherited

Since: ArcGIS API for JavaScript 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(groupKey)inherited

Since: ArcGIS API for JavaScript 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");