Skip to content
import GamepadSettings from "@arcgis/core/views/navigation/gamepad/GamepadSettings.js";
Inheritance:
GamepadSettingsAccessor
Since
ArcGIS Maps SDK for JavaScript 4.9

Gamepad navigation specific configuration settings.

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
PropertyTypeClass
declaredClass
readonly inherited
"pan" | "zoom"
"forward-down" | "forward-up"

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

device

autocast Property
Type
GamepadInputDevice | null | undefined

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.

See also

enabled

Property
Type
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
Type
"pan" | "zoom"

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"

Default value
"pan"
Example
// Setting the navigation mode to "zoom"
sceneView.navigation.gamepad.mode = "zoom";

tiltDirection

Property
Type
"forward-down" | "forward-up"

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.

Default value
"forward-down"