Issue #16: Add ability to toggle controls on/off via API (#63)

Author: indigoxela

js/leaflet.backdrop.js

@@ -93,14 +93,20 @@
           popupMinWidth = this.map.popupMinWidth;
         }
 
+        // Defensive coding: mapControls gets set in leaflet_build_map(), but
+        // might be missing in edge cases.
+        let controls = (this.mapControls) ? this.mapControls : {};
+        let settings = {};
+        if (controls.ControlFullscreen) {
+          settings.fullscreenControl = true;
+        }
         // load a settings object with all of our map settings
-        var settings = {
-          'fullscreenControl': true,
-        };
         for (let setting in this.map.settings) {
           settings[setting] = this.map.settings[setting];
         }
-        settings.zoomControl = false; // replaced by L.Control.Zoomslider
+        if (controls.ControlZoomslider) {
+          settings.zoomControl = false; // replaced by L.Control.Zoomslider
+        }
 
         // Workaround for Safari bug.
         // @see https://github.com/backdrop-contrib/leaflet/issues/17
@@ -171,27 +177,39 @@
         }
 
         // add scale control //+
-          lMap.addControl(new L.control.scale({imperial: false}));
+        if (controls.ControlScale) {
+          // @todo Evaluate options for dynamic options (imperial).
+          let scaleControl = new L.control.scale({imperial: false});
+          lMap.scaleControl = scaleControl;
+          lMap.addControl(scaleControl);
+        }
 
         // add Zoomslider control //+
-          lMap.addControl(new L.Control.Zoomslider());
+        if (controls.ControlZoomslider) {
+          let zoomsliderControl = new L.Control.Zoomslider();
+          lMap.zoomsliderControl = zoomsliderControl;
+          lMap.addControl(zoomsliderControl);
+        }
 
         // Small box with lat/lon coordinates of mouse click event on map.
-        var c = new L.Control.Coordinates({
-          promptText: Backdrop.t('Press Ctrl+C to copy coordinates'),
-          precision: 5
-        });
-        c.addTo(lMap);
-        lMap.on('click', function(e) {
-          c.setCoordinates(e);
-          // Hide the coordinates box again after 4 seconds.
-          if (typeof this.hideTimer !== 'undefined') {
-            clearTimeout(this.hideTimer);
-          }
-          this.hideTimer = window.setTimeout(function() {
-            c._container.classList.add('hidden');
-          }, 4000);
-        });
+        if (controls.ControlCoordinates) {
+          let c = new L.Control.Coordinates({
+            promptText: Backdrop.t('Press Ctrl+C to copy coordinates'),
+            precision: 5
+          });
+          lMap.coordinatesControl = c;
+          c.addTo(lMap);
+          lMap.on('click', function(e) {
+            c.setCoordinates(e);
+            // Hide the coordinates box again after 4 seconds.
+            if (typeof this.hideTimer !== 'undefined') {
+              clearTimeout(this.hideTimer);
+            }
+            this.hideTimer = window.setTimeout(function() {
+              c._container.classList.add('hidden');
+            }, 4000);
+          });
+        }
 
         let zoom = this.map.settings.zoom ? this.map.settings.zoom : this.map.settings.zoomDefault;
         // Init ViewCenter plugin with some defaults.
@@ -202,7 +220,11 @@
           vcLatLng: [0, 0],
           vcZoom: zoom
         });
-        lMap.addControl(viewCenter);
+        // @todo viewCenter is in use further down. Might need restructuring.
+        if (controls.ControlViewCenter) {
+          lMap.viewCenterControl = viewCenter;
+          lMap.addControl(viewCenter);
+        }
 
         // center the map
         if (this.map.center && (this.map.center.force || this.features.length === 0)) {

leaflet.api.php

@@ -87,10 +87,21 @@ function hook_leaflet_map_info() {
  * @param array $settings
  *   A javascript settings array used for building the leaflet map.
  *
- * @see leaflet_map_get_info()
- * @see hook_leaflet_map_info()
+ * @see leaflet_build_map()
  */
 function hook_leaflet_map_prebuild_alter(array &$settings) {
   $settings['mapId'] = 'my-map-id';
   $settings['features']['icon'] = 'my-icon-url';
+
+  // Remove all controls. Available for all controls besides (dynamic) layer
+  // switcher or attribution.
+  $settings['mapControls']['ControlFullscreen'] = FALSE;
+  $settings['mapControls']['ControlScale'] = FALSE;
+  $settings['mapControls']['ControlZoomslider'] = FALSE;
+  $settings['mapControls']['ControlCoordinates'] = FALSE;
+  $settings['mapControls']['ControlViewCenter'] = FALSE;
+
+  // Also turn off default zoom buttons, which would appear, as the Zoomslider
+  // has been turned off above.
+  $settings['map']['settings']['zoomControl'] = FALSE;
 }

leaflet.module

@@ -136,6 +136,14 @@ function leaflet_build_map(array $map, array $features = array(), $height = '400
   $settings = array(
     'mapId' => $map_id,
     'map' => $map,
+    // Also expose our additional (mostly plugin) controls to hook.
+    'mapControls' => array(
+      'ControlFullscreen' => TRUE,
+      'ControlScale' => TRUE,
+      'ControlZoomslider' => TRUE,
+      'ControlCoordinates' => TRUE,
+      'ControlViewCenter' => TRUE,
+    ),
     'features' => $features,
   );
   backdrop_alter('leaflet_map_prebuild', $settings);