require(["esri/views/input/gamepad/GamepadInputDevice"], (GamepadInputDevice) => { /* code goes here */ });
import GamepadInputDevice from "@arcgis/core/views/input/gamepad/GamepadInputDevice.js";
esri/views/input/gamepad/GamepadInputDevice
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 | macOS |
|---|---|---|
| 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 Maps SDK for JavaScript may explicitly disable gamepad capabilities on non-secure contexts.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
The native Gamepad object exposed by the browser. | GamepadInputDevice |
Property Details
-
native
Propertynative Gamepadreadonly -
The native Gamepad object exposed by the browser.
Method Overview
| 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
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");