NavigationActionMap | API Reference | ArcGIS Maps SDK for JavaScript

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

Type	Summary	Class
String	The name of the class.	Accessor
DragAction	The primary drag navigation action.	NavigationActionMap
DragAction	The secondary drag navigation action.	NavigationActionMap
DragAction	The tertiary drag navigation action.	NavigationActionMap
String	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

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

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"