NavigationActionMap

AMD: require(["esri/views/navigation/NavigationActionMap"], (NavigationActionMap) => { /* code goes here */ });
ESM: import NavigationActionMap from "@arcgis/core/views/navigation/NavigationActionMap.js";
Class: esri/views/navigation/NavigationActionMap
Inheritance: NavigationActionMapAccessor
Since: ArcGIS Maps SDK for JavaScript 4.32

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

Known Limitations

  • The zoom action is only supported in a SceneView.
  • The dragTertiary action is only supported in a SceneView.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

The primary drag navigation action.

NavigationActionMap

The secondary drag navigation action.

NavigationActionMap

The tertiary drag navigation action.

NavigationActionMap

The mouse wheel zoom action.

NavigationActionMap

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

dragPrimary

Property
dragPrimary DragAction

The primary drag navigation action. On a mouse, this corresponds to a drag while the primary button (usually the left button) is pressed. On a touch device, this corresponds to a single touch drag. The zoom action is only supported in a SceneView

Default Value:"pan"

dragSecondary

Property
dragSecondary DragAction

The secondary drag navigation action. On a mouse, this corresponds to a drag while the secondary button (usually the right button) is pressed. On a touch device, this corresponds to a two-finger twist gesture. The zoom action is only supported in a SceneView

Default Value:"rotate"

dragTertiary

Property
dragTertiary DragAction

The tertiary drag navigation action. On a mouse, this corresponds to a drag while the tertiary button (usually the middle button) is pressed. On a touch device, this corresponds to a two-finger pinch gesture. This is only supported in a SceneView.

Default Value:"zoom"

mouseWheel

Property
mouseWheel String

The mouse wheel zoom action. This action is triggered when the mouse wheel is scrolled.

Possible Values:"zoom" |"none"

Default Value:"zoom"

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor

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

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

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");

Type Definitions

DragAction

Type Definition
DragAction String

Type of action to be performed when a drag gesture is performed.

Possible Values:"pan" |"rotate" |"zoom" |"none"

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close