Navigation | References | ArcGIS Maps SDK for JavaScript

import Navigation from "@arcgis/core/views/navigation/Navigation.js";

Inheritance:: Navigation→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.9

Navigation related configuration settings on the View.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`NavigationProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`actionMap`	`NavigationActionMap`
`browserTouchPanEnabled`	`boolean`
`declaredClass` readonly inherited	`string`	Accessor
`gamepad` readonly	`GamepadSettings`
`momentumEnabled`	`boolean`

actionMap

autocast Property

Type: NavigationActionMap

Since: ArcGIS Maps SDK for JavaScript 4.32

The navigation action map defines the default behavior of the navigation controls.

Example

// By default, dragging the middle mouse button (tertiary button) zooms the SceneView. By setting the tertiary
// drag action to "none", that default behavior can be disabled.
view.navigation.actionMap.dragTertiary = "none";

browserTouchPanEnabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.14

Indicates if single finger touch View.@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

readonlyinherited Property

Type: string

Inherited from: Accessor

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

gamepad

readonly Property

Type: 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

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.14

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

With respect to MapView, this property will be ignored if Config is true and the user has requested reduced motion. See prefers-reduced-motion for more information.

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;