Naboo's Podracing Misadventure
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

leaflet-compass

1.5.2 • Public • Published

Leaflet.Control.Compass

A leaflet control plugin to make simple rotating compass

Tested in Leaflet 0.7 and 1.2

require HTML5 API on mobile device!

Tested platforms:

  • Chrome on Android
  • Safari on iOS

Demo online:
labs.easyblog.it/maps/leaflet-compass

Image

Usage

Adding the Compass Control to the map:

map.addControl( new L.Control.Compass() );

Options

Option Default Description
autoActive false activate control at startup
showDigit true show angle value bottom compass
textErr '' error message on alert notification
callErr null function that run on compass error activating
angleOffset 2 min angle deviation before rotate, big angleOffset is need for device have noise in orientation sensor
position 'topright' position of control inside map

Methods

  • getAngle return Azimut angle
  • setAngle set rotation compass
  • activate active tracking on runtime
  • deactivate deactive tracking on runtime

Events

  • compass:rotated fired after compass data is rotated
  • compass:disabled fired when compass is disabled

Where

Source code:

Github
Bitbucket
Atmosphere NPM

install

npm i leaflet-compass

Downloadsweekly downloads

49

version

1.5.2

license

MIT

repository

githubgithub

last publish

collaborators

  • avatar