• esri/views

GamepadSettings

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

Gamepad navigation specific configuration settings.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
GamepadInputDevice

Use this property to explicitly select the gamepad device for map and scene navigation.

more details
GamepadSettings
Boolean

Whether gamepad navigation is enabled on the View.

more details
GamepadSettings
String

This setting controls the behavior of forward and back movement of the left stick.

more details
GamepadSettings
String

Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith).

more details
GamepadSettings

Property Details

declaredClass Stringreadonly inherited

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

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
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 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 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
Name Return Type Summary Class

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

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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");

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