DirectionalPadViewModel | API Reference | ArcGIS Maps SDK for JavaScript

Provides the logic for the DirectionalPad widget and component.

See also

DirectionalPad widget - Deprecated since 4.32. Use the DirectionalPad component instead.
Directional Pad component
Programming patterns: Widget viewModel pattern

The DirectionalPad widget is not supported in 3d.

Constructors

DirectionalPadViewModel Constructor new DirectionalPadViewModel(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Number\|null\|undefined	The closest angle that matches the current mouse position relative to the widget's center.	DirectionalPadViewModel
String	The name of the class.	Accessor
Boolean	Indicates whether interaction is allowed on the widget.	DirectionalPadViewModel
Number	The angle of rotation of the map.	DirectionalPadViewModel
String	The state of the view model.	DirectionalPadViewModel
MapView\|null\|undefined	The view which the directional pad will control.	DirectionalPadViewModel

Property Details

angle Property angle Number |null |undefinedreadonly

The closest angle that matches the current mouse position relative to the widget's center. There are eight possible angles, -45, 0, 45, -90, 90, -135, 180, and 135. If the widget is not in motion, the value is undefined.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

disabled Property disabled Boolean

Indicates whether interaction is allowed on the widget. When true, this property sets the widget to a disabled state to stop user interaction.

Default Value:false

rotation Property rotation Number

The angle of rotation of the map. Ranges from 0 to 360

Default Value:0

Example

reactiveUtils.watch(
 ()=>directionalPadViewModel.rotation,
 (newAngle,oldAngle)=> console.log({ newAngle, oldAngle })
);

state Property state Stringreadonly

The state of the view model.

Possible Values:"disabled" |"ready" |"moving"

view Property view MapView |null |undefined

The view which the directional pad will control. If not provided, you can manually listen to emitted events and control the map accordingly.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
	Starts movement in the correct direction according to pointer location, and listens for pointer move (to change direction) or release (to stop movement) This method should be called in response to pointerdown event on a button	DirectionalPadViewModel
Boolean	Returns true if a named group of handles exist.	Accessor
	Initialize a brief movement in a desired direction	DirectionalPadViewModel
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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

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.

beginFollowingPointer Method beginFollowingPointer(pointerLocation, widgetCenter)

Starts movement in the correct direction according to pointer location, and listens for pointer move (to change direction) or release (to stop movement)

This method should be called in response to pointerdown event on a button

Parameters

pointerLocation Vector

Current pointer location

widgetCenter Vector

The center of the DirectionalPad widget

Example

moveLeftButton.addEventListener("pointerDown", (event) => {
  const { x, y, width, height } = buttonsContainer.getBoundingClientRect();
  const widgetCenter = { x: x + width / 2, y: y + height / 2 };
  directionalPadViewModel.beginFollowingPointer(event, widgetCenter);
});

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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

moveOnce Method moveOnce(angle)

Initialize a brief movement in a desired direction

Parameter

angle Number

Angle in the [0, 360] range

Example

moveLeftButton.addEventListener("keydown", () => {
  directionalPadViewModel.moveOnce(90);
});

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

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

Type Definitions

Vector Type Definition Vector

An x/y coordinate pair. Could be used to represent a screen point or a vector.

Properties: x Number

optional
X coordinate

y Number

optional
Y coordinate