CompassViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Provides the logic for the Compass widget.

The Compass indicates where north is in relation to the current view rotation or camera heading. This is added to a SceneView by default.

See also

Example

let view = new MapView({
  container: "viewDiv",
  map: map
});

let compass = new Compass({
  viewModel: {  // autocasts as new CompassViewModel()
    view: view
  })
}, "compassDiv");

Constructors

CompassViewModel Constructor new CompassViewModel(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
String	The name of the class.	Accessor
GoToOverride	This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.	CompassViewModel
Orientation	The z axis orientation.	CompassViewModel
String	The view model's state.	CompassViewModel
MapView\|SceneView	The view in which the Compass obtains and indicates camera heading, using a (SceneView) or rotation (MapView).	CompassViewModel

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

goToOverride Property goToOverride GoToOverride Since: ArcGIS Maps SDK for JavaScript 4.8 CompassViewModel since 4.0, goToOverride added at 4.8.

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also

esri/views/MapView#goTo
SceneView

Example

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options = {
    duration: updatedDuration
  };
  return view.goTo(goToParams.target, goToParams.options);
};

orientation Property orientation Orientationreadonly

The z axis orientation.

Default Value:{ z: 0 }

state Property state Stringreadonly

The view model's state.

Possible Values:"compass" |"rotation" |"disabled"

Default Value:"disabled"

view Property view MapView |SceneView

The view in which the Compass obtains and indicates camera heading, using a (SceneView) or rotation (MapView).

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
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
	If working in a MapView, sets the view's rotation is to `0`.	CompassViewModel

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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");

reset Method reset()

If working in a MapView, sets the view's rotation is to 0. If working in a SceneView, sets the camera's heading to 0.

This method is executed each time the Compass is clicked.

Type Definitions

Orientation Type Definition Orientation

The z axis orientation.

Property: z Number

optional
z axis orientation.