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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
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

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

orientationObject

The orientation axes (x, y, z).

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

The view model's state.

Known 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

NameReturn TypeSummaryClass

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.

Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.