Maptalks.control.compass NPM

maptalks.control.compass

A maptalks Compass Control.

Examples

DEMO

Install

Install with npm: npm install maptalks.control.compass.
Install with yarn: yarn add maptalks.control.compass.
Download from dist directory.
Use unpkg CDN: https://cdn.jsdelivr.net/npm/maptalks.control.compass/dist/maptalks.control.compass.min.js and https://cdn.jsdelivr.net/npm/maptalks.control.compass/css/maptalks.control.compass.css

Usage

As a Maptalks.control, maptalks.control.compass must be loaded after maptalks.js in browsers. You can also use 'import { CompassControl } from "maptalks.control.compass" and 'import "maptalks.control.compass/css/maptalks.control.compass.css" when developing with webpack.

<!-- ... -->
<script src="https://cdn.jsdelivr.net/npm/maptalks.control.compass/dist/maptalks.control.compass.min.js"></script>
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/maptalks.control.compass/css/maptalks.control.compass.css"
/>
<!-- ... -->

// new Control: CompassControl, and add to map.
new maptalks.CompassControl({
  position: 'top-right',
  backgroundColor: '#00BCD4', // 'rgba(235, 235, 235, .65)'
  transform: 'scale(1.2) translate(10%, 10%)',
  resetViewTriggers: 'click dblclick', // ['dblclick contextmenu', {duration: 500}]
}).addTo(map)
// All options are optional.

API Reference

new maptalks.CompassControl(options)

options optional
- position String - like other maptalks.Control.
- backgroundColor String - background-color of the compass.
- transform String - the compass dom's style: 'transform: %s'.
- resetViewTriggers String | Array - set event triggers on Compass to set map view to {bearing: 0, pitch: 0}.
events
- add
- remove
- positionchange
- click
- dblclick
- contextmenu