GamepadSettings | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Gamepad navigation specific configuration settings.

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
GamepadInputDevice	Use this property to explicitly select the gamepad device for map and scene navigation.	GamepadSettings
Boolean	Whether gamepad navigation is enabled on the View.	GamepadSettings
String	This setting controls the behavior of forward and back movement of the left stick.	GamepadSettings
String	Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith).	GamepadSettings

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.

device Property device GamepadInputDevice

Use this property to explicitly select the gamepad device for map and scene navigation. If unspecified then all connected gamepads will be able to navigate.

Default Value:null

See also

View.input.gamepad.devices for a collection of detected gamepads.

enabled Property enabled Boolean

Whether gamepad navigation is enabled on the View. If this is enabled, but no device is specified, the first supported one will be selected automatically.

Default Value:true

mode Property mode String

This setting controls the behavior of forward and back movement of the left stick. If set to pan, movement will be at a constant altitude (panning the view forward and backward) whereas zoom will move the view in the viewing direction. Pan is best suited for exploring a scene as if on foot or in a car. Zoom mode provides great control to navigate the scene similar to a flight simulator.

The following are the possible values for each view: MapView: "pan" SceneView: "pan" | "zoom"

Possible Values:"pan" |"zoom"

Default Value:"pan"

Example

// Setting the navigation mode to "zoom"
sceneView.navigation.gamepad.mode = "zoom";

tiltDirection Property tiltDirection String

Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith). The default behavior is to tilt the view down when pressing the stick that controls tilt forwards.

Possible Values:"forward-down" |"forward-up"

Default Value:"forward-down"

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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");