Skip To ContentArcGIS for DevelopersSign In Dashboard

Navigation

Class: esri/views/navigation/Navigation
Inheritance: Navigation Accessor
Since: ArcGIS API for JavaScript 4.9

Navigation related configuration settings on the View.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Boolean

Indicates if single finger touch drag events are enabled or disabled.

more details
more detailsNavigation
String

The name of the class.

more details
more detailsAccessor
GamepadSettings

Gamepad navigation specific configuration settings.

more details
more detailsNavigation
Boolean

When true, the view will temporarily continue to pan after the pointer (e.g.

more details
more detailsNavigation
Boolean

Indicates whether the view can be zoomed in or out with the mouse wheel.

more details
more detailsNavigation

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"
  })
});
view.navigation.browserTouchPanEnabled = false;
declaredClass Stringreadonly inherited

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

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"
  })
});
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"
  })
});
view.navigation.mouseWheelZoomEnabled = false;

API Reference search results

NameTypeModule
Loading...