DEPRECATED

!No Maintenance Intended

---

leaflet-graphicscale

A animated graphic scale for Leaflet.js that looks sharp.

![Image][1]

Demo : http://nerik.github.io/leaflet-graphicscale/demo/

Why ?

Because scale is an important component of a map, and it is often overlooked. Leaflet does have a default scale component (http://leafletjs.com/reference.html#control-scale), but honestly it's kind of boring.

This plugin provides a more interesting alternative with more customizability.

Contributing

Yes, please. I haven't had the time to make proper tests but they would be much needed.
Also I've heard that there are some parts on the globe where they don't use the metric system, so if you'd like to add your measurement system be my guest (furlongs, wiffles, smoots, miles... http://en.wikipedia.org/wiki/List_of_humorous_units_of_measurement)

To run the demo locally (you'll need ``sass`):
`
npm run dev
`




Getting started

$3

`
















`

See below for `[options]`

$3

`
npm install -S leaflet-graphicscale
`

SASS :
`
@import './node_modules/leaflet-graphicscale/src/Leaflet.GraphicScale.scss';
`

JS :
`
require('leaflet-graphicscale');
var graphicScale = L.control.graphicScale().addTo(map);
`




Options

$3

Default: false

- false/'nofill'

![](http://nerik.github.io/leaflet-graphicscale/readme/nofill.png)

- 'fill'

![](http://nerik.github.io/leaflet-graphicscale/readme/fill.png)

- 'hollow'

![](http://nerik.github.io/leaflet-graphicscale/readme/hollow.png)

- 'line'

![](http://nerik.github.io/leaflet-graphicscale/readme/line.png)




$3

Default: false

![](http://nerik.github.io/leaflet-graphicscale/readme/double.png)




$3

Default: false. Show smaller divisions on the left of the zero.

![](http://nerik.github.io/leaflet-graphicscale/readme/sub.png)




$3

Default: 30. The minimum width of a scale unit.

$3

Default: 240. The maximum width of the scale without subunits.

$3

Default: auto. Display the distance label on top/on the bottom of the scale bar. If set to auto, labels will be placed on top when the scale control is on the bottom of the map, and on the bottom when the scale control is on the top of the map (`position`` parameter)

$3

See http://leafletjs.com/reference.html#control

$3

See http://leafletjs.com/reference.html#control-scale

[1]: http://nerik.github.io/leaflet-graphicscale/demo/