• esri/views

GamepadInputDevice

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

Properties and configuration of a gamepad.

Two types of devices are currently supported: Standard Gamepads and 3Dconnexion devices.

A standard gamepad will have standardized mappings for buttons and axes, like the XBox360 controller and the DualShock 4 controller (PlayStation 4 controller). To find out more information about your device and test its connection with certain browsers, please refer to the HTML5 Gamepad Tester.

The W3C standard for Gamepad is still in draft status. As such, support is limited to a subset of browsers and operating systems. We have not tested every browser/OS combination but as a general guide we have experienced reliable results with the following pairings:

Browser Windows Mac
Chrome XBox360
XBox One
3DConnexion Devices
PS4 Controller
XBox360
XBox One
3DConnexion Devices
PS4 Controller
Firefox XBox360
XBox One
No gamepad devices support this browser/OS combination
Edge(17 and above) XBox360
XBox One
This browser is not supported on this OS
Safari This browser is not supported on this OS No gamepad devices support this browser/OS combination

Notes:

  • You might need to restart your browser after connecting a device.
  • Per W3C Working Draft 29 October 2020, gamepad functionality may not be available on some or all browsers if the web application is hosted on a non-secure context (e.g. http rather than https). Future versions of the ArcGIS API for JavaScript may explicitly disable gamepad capabilities on non-secure contexts.

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
Gamepad

The native Gamepad object exposed by the browser.

more details
GamepadInputDevice

Property Details

declaredClass Stringreadonly inherited

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

native Gamepadreadonly

The native Gamepad object exposed by the browser.

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 API 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 API 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 API 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.