Leaflet control

folium/features.py

@@ -7,7 +7,18 @@
 import json
 import operator
 import warnings
-from typing import Any, Callable, Dict, Iterable, List, Optional, Sequence, Tuple, Union
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Iterable,
+    List,
+    Literal,
+    Optional,
+    Sequence,
+    Tuple,
+    Union,
+)
 
 import numpy as np
 import requests
@@ -20,6 +31,7 @@
 from folium.folium import Map
 from folium.map import FeatureGroup, Icon, Layer, Marker, Popup, Tooltip
 from folium.utilities import (
+    JsCode,
     TypeJsonValue,
     TypeLine,
     TypePathOptions,
@@ -1973,3 +1985,65 @@ def __init__(
             out.setdefault(cm(color), []).append([[lat1, lng1], [lat2, lng2]])
         for key, val in out.items():
             self.add_child(PolyLine(val, color=key, weight=weight, opacity=opacity))
+
+
+class Control(MacroElement):
+    """
+    Add a Leaflet Control object to the map
+
+    Parameters
+    ----------
+    control: str
+        The javascript class name of the control to be rendered.
+    position: str
+        One of "bottomright", "bottomleft", "topright", "topleft"
+
+    Examples
+    --------
+
+    >>> import folium
+    >>> from folium.features import Control, Marker
+    >>> from folium.plugins import Geocoder
+
+    >>> m = folium.Map(
+    ...     location=[46.603354, 1.8883335], attr=None, zoom_control=False, zoom_start=5
+    ... )
+    >>> Control("Zoom", position="topleft").add_to(m)
+    """
+
+    _template = Template(
+        """
+      {% macro script(this, kwargs) %}
+          var {{ this.get_name() }}_options = {{ this.options|tojson }};
+          {% for key, value in this.functions.items() %}
+          {{ this.get_name() }}_options["{{key}}"] = {{ value }};
+          {% endfor %}
+
+          var {{ this.get_name() }} = new L.Control.{{this._name}}(
+              {{ this.get_name() }}_options
+          ).addTo({{ this._parent.get_name() }});
+      {% endmacro %}
+    """
+    )
+
+    def __init__(
+        self,
+        control: Optional[str] = None,
+        position: Literal[
+            "bottomright", "bottomleft", "topright", "topleft"
+        ] = "bottomleft",
+        **kwargs,
+    ):
+        super().__init__()
+        if control:
+            self._name = control
+        kwargs["position"] = position
+
+        # extract JsCode objects
+        self.functions = {}
+        for key, value in list(kwargs.items()):
+            if isinstance(value, JsCode):
+                self.functions[camelize(key)] = value.js_code
+                kwargs.pop(key)
+
+        self.options = parse_options(**kwargs)

folium/plugins/beautify_icon.py

@@ -95,7 +95,7 @@ def __init__(
         inner_icon_style="",
         spin=False,
         number=None,
-        **kwargs
+        **kwargs,
     ):
         super().__init__()
         self._name = "BeautifyIcon"
@@ -111,5 +111,5 @@ def __init__(
             spin=spin,
             isAlphaNumericIcon=number is not None,
             text=number,
-            **kwargs
+            **kwargs,
         )

folium/plugins/draw.py

@@ -1,10 +1,11 @@
-from branca.element import Element, Figure, MacroElement
+from branca.element import Element, Figure
 from jinja2 import Template
 
 from folium.elements import JSCSSMixin
+from folium.features import Control
 
 
-class Draw(JSCSSMixin, MacroElement):
+class Draw(JSCSSMixin, Control):
     """
     Vector drawing and editing plugin for Leaflet.
 

folium/plugins/fullscreen.py

@@ -1,11 +1,11 @@
-from branca.element import MacroElement
 from jinja2 import Template
 
 from folium.elements import JSCSSMixin
+from folium.features import Control
 from folium.utilities import parse_options
 
 
-class Fullscreen(JSCSSMixin, MacroElement):
+class Fullscreen(JSCSSMixin, Control):
     """
     Adds a fullscreen button to your map.
 
@@ -56,7 +56,7 @@ def __init__(
         title="Full Screen",
         title_cancel="Exit Full Screen",
         force_separate_button=False,
-        **kwargs
+        **kwargs,
     ):
         super().__init__()
         self._name = "Fullscreen"
@@ -65,5 +65,5 @@ def __init__(
             title=title,
             title_cancel=title_cancel,
             force_separate_button=force_separate_button,
-            **kwargs
+            **kwargs,
         )

folium/plugins/geocoder.py

@@ -1,13 +1,13 @@
 from typing import Optional
 
-from branca.element import MacroElement
 from jinja2 import Template
 
 from folium.elements import JSCSSMixin
+from folium.features import Control
 from folium.utilities import parse_options
 
 
-class Geocoder(JSCSSMixin, MacroElement):
+class Geocoder(JSCSSMixin, Control):
     """A simple geocoder for Leaflet that by default uses OSM/Nominatim.
 
     Please respect the Nominatim usage policy:
@@ -78,7 +78,7 @@ def __init__(
         zoom: Optional[int] = 11,
         provider: str = "nominatim",
         provider_options: dict = {},
-        **kwargs
+        **kwargs,
     ):
         super().__init__()
         self._name = "Geocoder"
@@ -89,5 +89,5 @@ def __init__(
             zoom=zoom,
             provider=provider,
             provider_options=provider_options,
-            **kwargs
+            **kwargs,
         )

folium/plugins/groupedlayercontrol.py

@@ -1,11 +1,11 @@
-from branca.element import MacroElement
 from jinja2 import Template
 
 from folium.elements import JSCSSMixin
+from folium.features import Control
 from folium.utilities import parse_options
 
 
-class GroupedLayerControl(JSCSSMixin, MacroElement):
+class GroupedLayerControl(JSCSSMixin, Control):
     """
     Create a Layer Control with groups of overlays.
 

folium/plugins/heat_map.py

@@ -74,7 +74,7 @@ def __init__(
         overlay=True,
         control=True,
         show=True,
-        **kwargs
+        **kwargs,
     ):
         super().__init__(name=name, overlay=overlay, control=control, show=show)
         self._name = "HeatMap"
@@ -96,7 +96,7 @@ def __init__(
             radius=radius,
             blur=blur,
             gradient=gradient,
-            **kwargs
+            **kwargs,
         )
 
     def _get_self_bounds(self):

folium/plugins/locate_control.py

@@ -3,14 +3,14 @@
 Based on leaflet plugin: https://github.com/domoritz/leaflet-locatecontrol
 """
 
-from branca.element import MacroElement
 from jinja2 import Template
 
 from folium.elements import JSCSSMixin
+from folium.features import Control
 from folium.utilities import parse_options
 
 
-class LocateControl(JSCSSMixin, MacroElement):
+class LocateControl(JSCSSMixin, Control):
     """Control plugin to geolocate the user.
 
     This plugins adds a button to the map, and when it's clicked shows the current

folium/plugins/marker_cluster.py

@@ -87,7 +87,7 @@ def __init__(
         show=True,
         icon_create_function=None,
         options=None,
-        **kwargs
+        **kwargs,
     ):
         if options is not None:
             kwargs.update(options)  # options argument is legacy

folium/plugins/measure_control.py

@@ -1,11 +1,11 @@
-from branca.element import MacroElement
 from jinja2 import Template
 
 from folium.elements import JSCSSMixin
+from folium.features import Control
 from folium.utilities import parse_options
 
 
-class MeasureControl(JSCSSMixin, MacroElement):
+class MeasureControl(JSCSSMixin, Control):
     """Add a measurement widget on the map.
 
     Parameters
@@ -68,7 +68,7 @@ def __init__(
         secondary_length_unit="miles",
         primary_area_unit="sqmeters",
         secondary_area_unit="acres",
-        **kwargs
+        **kwargs,
     ):
         super().__init__()
         self._name = "MeasureControl"
@@ -79,5 +79,5 @@ def __init__(
             secondary_length_unit=secondary_length_unit,
             primary_area_unit=primary_area_unit,
             secondary_area_unit=secondary_area_unit,
-            **kwargs
+            **kwargs,
         )

folium/plugins/minimap.py

@@ -1,12 +1,12 @@
-from branca.element import MacroElement
 from jinja2 import Template
 
 from folium.elements import JSCSSMixin
+from folium.features import Control
 from folium.raster_layers import TileLayer
 from folium.utilities import parse_options
 
 
-class MiniMap(JSCSSMixin, MacroElement):
+class MiniMap(JSCSSMixin, Control):
     """Add a minimap (locator) to an existing map.
 
     Uses the Leaflet plugin by Norkart under BSD 2-Clause "Simplified" License.
@@ -103,7 +103,7 @@ def __init__(
         toggle_display=False,
         auto_toggle_display=False,
         minimized=False,
-        **kwargs
+        **kwargs,
     ):
         super().__init__()
         self._name = "MiniMap"
@@ -128,5 +128,5 @@ def __init__(
             toggle_display=toggle_display,
             auto_toggle_display=auto_toggle_display,
             minimized=minimized,
-            **kwargs
+            **kwargs,
         )

folium/plugins/mouse_position.py

@@ -1,11 +1,9 @@
-from branca.element import MacroElement
-from jinja2 import Template
-
 from folium.elements import JSCSSMixin
-from folium.utilities import parse_options
+from folium.features import Control
+from folium.utilities import JsCode
 
 
-class MousePosition(JSCSSMixin, MacroElement):
+class MousePosition(JSCSSMixin, Control):
     """Add a field that shows the coordinates of the mouse position.
 
     Uses the Leaflet plugin by Ardhi Lukianto under MIT license.
@@ -45,34 +43,6 @@ class MousePosition(JSCSSMixin, MacroElement):
 
     """
 
-    _template = Template(
-        """
-        {% macro script(this, kwargs) %}
-            var {{ this.get_name() }} = new L.Control.MousePosition(
-                {{ this.options|tojson }}
-            );
-            {{ this.get_name() }}.options["latFormatter"] =
-                {{ this.lat_formatter }};
-            {{ this.get_name() }}.options["lngFormatter"] =
-                {{ this.lng_formatter }};
-            {{ this._parent.get_name() }}.addControl({{ this.get_name() }});
-        {% endmacro %}
-    """
-    )
-
-    default_js = [
-        (
-            "Control_MousePosition_js",
-            "https://cdn.jsdelivr.net/gh/ardhi/Leaflet.MousePosition/src/L.Control.MousePosition.min.js",
-        )
-    ]
-    default_css = [
-        (
-            "Control_MousePosition_css",
-            "https://cdn.jsdelivr.net/gh/ardhi/Leaflet.MousePosition/src/L.Control.MousePosition.min.css",
-        )
-    ]
-
     def __init__(
         self,
         position="bottomright",
@@ -83,19 +53,25 @@ def __init__(
         prefix="",
         lat_formatter=None,
         lng_formatter=None,
-        **kwargs
+        **kwargs,
     ):
-        super().__init__()
-        self._name = "MousePosition"
-
-        self.options = parse_options(
+        super().__init__(
+            control="MousePosition",
             position=position,
             separator=separator,
             empty_string=empty_string,
             lng_first=lng_first,
             num_digits=num_digits,
             prefix=prefix,
-            **kwargs
+            lat_formatter=JsCode(lat_formatter) if lat_formatter else None,
+            lng_formatter=JsCode(lng_formatter) if lng_formatter else None,
+            **kwargs,
+        )
+        self.add_js_link(
+            "Control_MousePosition_js",
+            "https://cdn.jsdelivr.net/gh/ardhi/Leaflet.MousePosition/src/L.Control.MousePosition.min.js",
+        )
+        self.add_css_link(
+            "Control_MousePosition_css",
+            "https://cdn.jsdelivr.net/gh/ardhi/Leaflet.MousePosition/src/L.Control.MousePosition.min.css",
         )
-        self.lat_formatter = lat_formatter or "undefined"
-        self.lng_formatter = lng_formatter or "undefined"