CompassViewModel

require(["esri/widgets/Compass/CompassViewModel"], function(CompassVM) { /* code goes here */ });
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:
var view = new MapView({
  container: "viewDiv",
  map: map
});

var 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
more detailsAccessor
GoToOverride

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

more details
more detailsCompassViewModel
Object

The orientation axes (x, y, z).

more details
more detailsCompassViewModel
String

The view model's state.

more details
more detailsCompassViewModel
MapView|SceneView

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

more details
more detailsCompassViewModel

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

Name Return Type Summary Class

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

more details
more detailsCompassViewModel

Method Details

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.