require(["esri/widgets/Compass/CompassViewModel"], (CompassVM) => { /* code goes here */ });
import CompassVM from "@arcgis/core/widgets/Compass/CompassViewModel.js";
esri/widgets/Compass/CompassViewModel
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.
let view = new MapView({
container: "viewDiv",
map: map
});
let compass = new Compass({
viewModel: { // autocasts as new CompassViewModel()
view: view
})
}, "compassDiv");
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. | CompassViewModel | ||
The z axis orientation. | CompassViewModel | ||
The view model's state. | CompassViewModel | ||
The view in which the Compass obtains and indicates camera heading, using a (SceneView) or rotation (MapView). | CompassViewModel |
Property Details
-
goToOverride
goToOverride GoToOverride
Since: ArcGIS Maps SDK for JavaScript 4.8CompassViewModel since 4.0, goToOverride added at 4.8. -
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
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
orientation Orientationreadonly
-
The z axis orientation.
- Default Value:{ z: 0 }
-
state
state Stringreadonly
-
The view model's state.
Possible Values:"compass" |"rotation" |"disabled"
- Default Value:disabled
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
CompassViewModel |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
Type Definitions
-
The z axis orientation.
- Property
-
z Number
z axis orientation.