⛵️ A leaflet boat marker using HTML Canvas
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
LICENSE Initial commit Dec 28, 2014
README.md nom badge Feb 19, 2017
index.html index update Feb 19, 2017
leaflet.boatmarker.js pull up speed function Nov 6, 2016
leaflet.boatmarker.min.js minified version Nov 6, 2016
package.json Readme Update Feb 19, 2017

README.md

⛵️ Leaflet.BoatMarker npm version

A leaflet boat marker using HTML Canvas. Checkout the Demo.

Can be used to symbolize sailboats/sailyachts or motorboats/motoryachts with optional wind information.

Installation

  • Include the script directly
<script src="https://unpkg.com/leaflet.boatmarker/leaflet.boatmarker.min.js"></script>
  • Use in a build script via npm
npm i leaflet.boatmarker --save

Usage

var boatMarker = L.boatMarker(map.getCenter(), {
  	color: "#f1c40f", 	// color of the boat
	idleCircle: false	// if set to true, the icon will draw a circle if
						// boatspeed == 0 and the ship-shape if speed > 0
});
setHeading(heading)

Sets the current heading of the boat to an angle value between 0 and 360 degrees.

boatMarker.setHeading(60);
setHeadingWind(heading, windspeed, winddirection)

Sets the current heading of the boat to an angle value between 0 and 360 degrees, the current wind direction to an angle value between 0 and 360 degress and the wind speed (in knots) following this weather wind arrow specification http://www.wetterklima.de/segeln/windpfeile/bf.htm

boatMarker.setHeadingWind(60, 4.5, 20);
setSpeed(speed)

Set the current speed of the boat to a value > 0

boatMarker.setSpeed(12.9);