GamepadSettings

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

devices Collection<GamepadInputDevice>readonly

A readonly collection of all gamepads detected. This collection can be monitored for connecting and disconnecting gamepads. This property may only be populated after interaction with a connected gamepad device. See example below.

Example

const { devices } = view.input.gamepad;
devices.on("change", () => {
  console.log(`Available devices...`);
  for (const gamepad of devices) {
    const { id, index } = gamepad.native;
    console.log(`
      Device name:  ${id}
      Device index: ${index}
    `);
  }
});

enabledFocusMode String

Determines what focus is required for gamepad events to be dispatched.

Possible Value	Description
document	Gamepad events are emitted when any part of the current webpage has focus. This allows for gamepad events being emitted even while a UI element is focused.
view	Gamepad events are emitted when the view container element has browser focus. This is useful when multiple views might be present on a single webpage.
none	Gamepad events are emitted independently of focus.

Possible Values:"document"|"view"|"none"

Default Value:document

Method Overview

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");