A compass widget for Cesium based on @nsc-earth-2/common library. 中文 Readme
npm install @nsc-earth-2/compass
The Compass
widget can be used in a Cesium app to display a compass. To use the widget, first import it into your project:
import Compass from "@nsc-earth-2/compass";
Next, create a new instance of the widget and pass it your Cesium Viewer instance:
const viewer = new Cesium.Viewer("cesiumContainer");
const compass = new Compass(viewer);
You can also customize the widget by passing an options object when creating a new instance:
const compass = new Compass(viewer, {
container: document.getElementById("compass-container"),
tips: {
inner: "North",
outer: "Rotate",
},
});
Creates a new instance of the Compass
widget attached to the specified Cesium Viewer.
-
viewer
: The Cesium Viewer instance to attach the widget to. -
options
(optional): An object containing optional parameters for the widget.
A boolean property that controls whether the widget is enabled or not.
A boolean property indicating whether the widget is ready or not.
A method for hiding the widget.
A method for showing the widget.
Mounts the content of the widget.
The following options can be passed when creating a new instance of the Compass
widget:
-
container
(optional): The DOM element to mount the widget to. Defaults toviewer.container
. -
tips
(optional): An object containing strings for the inner and outer tips of the compass. Defaults to{ inner: '', outer: 'Drag outer ring: rotate view.\nDrag inner gyroscope: free orbit.\nDouble-click: reset view.\nTIP: You can also free orbit by holding the CTRL key and dragging the map.' }
.