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

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

Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

goToOverrideGoToOverride

Since: ArcGIS API for JavaScript 4.8

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

See also:

• MapView
• 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);
};

orientationObject

The orientation axes (x, y, z).

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

stateStringreadonly

The view model's state.

Possible Values: compass | rotation | disabled

Default Value:disabled

viewMapView|SceneView

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

Method Overview

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.