Add scale ruler option

Author: jperelli

README.md

@@ -30,6 +30,7 @@ Parameters that can be used (can be passed to the app server as GET query params
 | imagemin | enable lossless compression with [optipng](https://github.com/imagemin/imagemin-optipng) / [jpegtran](https://github.com/imagemin/imagemin-jpegtran) | `false` |
 | oxipng | enable losslsess compression with [oxipng](https://github.com/shssoichiro/oxipng) | `false` |
 | arrows | render arrows to show the direction of linestrings | `false` |
+| scale | enable render a scale ruler (boolean or [a json options object](https://leafletjs.com/reference-1.6.0.html#control-scale-option)) | `false` |
 
 ## How to use
 

lib/lib.d.ts

@@ -1,3 +1,5 @@
+import { Control } from "leaflet";
+
 export = _default;
 
 interface OsmStaticMapsOptions {
@@ -96,6 +98,12 @@ interface OsmStaticMapsOptions {
    * @defaultValue `false`
    */
   arrows?: boolean;
+
+  /**
+   * enable render a scale ruler (boolean or [a json options object](https://leafletjs.com/reference-1.6.0.html#control-scale-option))
+   * @defaultValue `false`
+   */
+  scale?: boolean | Control.ScaleOptions;
 }
 
 /** Renders a map controlled by the options passed and returns an image */

lib/lib.js

@@ -40,6 +40,7 @@ module.exports = function(options) {
     options.imagemin = options.imagemin || false;
     options.oxipng = options.oxipng || false;
     options.arrows = options.arrows || false;
+    options.scale = (options.scale && (typeof options.scale === 'string' ? options.scale : JSON.stringify(options.scale))) || false;
 
     const html = replacefiles(template(options));
 

lib/template.html

@@ -63,6 +63,10 @@
             });
             map.attributionControl.setPrefix('').addAttribution('{{ attribution }}');
 
+            {{#if scale}}
+                L.control.scale({{{scale}}}).addTo(map);
+            {{/if}}
+
             {{#if geojson }}
                 var myIcon = L.icon({
                     iconUrl: "data:image/png;base64,//markericonpng//",