@geoblocks/cesium-compass
v0.5.0
Published
Note: the code is based on the Compass class from [TerriaJS](https://github.com/TerriaJS/terriajs/blob/master/lib/ReactViews/Map/Navigation/Compass.jsx)
Downloads
1,252
Keywords
Readme
compass widget for Cesium
Note: the code is based on the Compass class from TerriaJS
Installation
npm i --save @geoblocks/cesium-compass
Usage
<cesium-compass .scene="${viewer.scene}" .clock="${viewer.clock}"></cesium-compass>
API
Properties/Attributes
| Name | Type | Default | Description
| --------------- | ---------------- | --------------- | -----------
| scene
| Cesium.Scene
| | A Cesium Scene instance
| clock
| Cesium.Clock
| | A Cesium Clock instance
| resetSpeed
| number
| Math.PI/100
| The speed of the reset to north animation in radians / milliseconds.
CSS Custom Properties
| Name | Default | Description
| ----------------------------------- | ------- | -----------
| --cesium-compass-stroke-color
| | Stroke color
| --cesium-compass-fill-color
| | Fill color