CompassViewModel

AMD: require(["esri/widgets/Compass/CompassViewModel"], (CompassVM) => { /* code goes here */ });
ESM: import CompassVM from "@arcgis/core/widgets/Compass/CompassViewModel";
Class: esri/widgets/Compass/CompassViewModel
Inheritance: CompassViewModel Accessor
Since: ArcGIS API for JavaScript 4.0

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

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
GoToOverride

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

more details
CompassViewModel
Object

The orientation axes (x, y, z).

more details
CompassViewModel
String

The view model's state.

more details
CompassViewModel
MapView|SceneView

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

more details
CompassViewModel

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

goToOverride GoToOverride
Since: ArcGIS API for JavaScript 4.8

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

See also
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 Object

The orientation axes (x, y, z).

Default Value:{ x: 0, y: 0, z: 0 }
state Stringreadonly

The view model's state.

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

Default Value:disabled

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
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

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

more details
CompassViewModel

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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 API 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 API 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");
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.