Add the GeoMan plugin

The GeoMan plugin is like the Draw plugin, with extra
functionality, such as support for Polygons with holes.

Author: hansthen

folium/plugins/__init__.py

@@ -11,6 +11,7 @@
 from folium.plugins.float_image import FloatImage
 from folium.plugins.fullscreen import Fullscreen
 from folium.plugins.geocoder import Geocoder
+from folium.plugins.geoman import GeoMan
 from folium.plugins.groupedlayercontrol import GroupedLayerControl
 from folium.plugins.heat_map import HeatMap
 from folium.plugins.heat_map_withtime import HeatMapWithTime
@@ -49,6 +50,7 @@
     "FloatImage",
     "Fullscreen",
     "Geocoder",
+    "GeoMan",
     "GroupedLayerControl",
     "HeatMap",
     "HeatMapWithTime",

folium/plugins/geoman.py

@@ -0,0 +1,101 @@
+from branca.element import MacroElement
+
+from folium.elements import JSCSSMixin
+from folium.template import Template
+from folium.utilities import remove_empty
+
+
+class GeoMan(JSCSSMixin, MacroElement):
+    """
+    An Open Source Leaflet Plugin for editing polygons
+
+    Examples
+    --------
+    >>> m = folium.Map()
+    >>> Geoman().add_to(m)
+
+    For more info please check
+    https://github.com/geoman-io/leaflet-geoman/
+
+    """
+
+    _template = Template(
+        """
+        {% macro script(this, kwargs) %}
+            {%- if this.feature_group  %}
+                var drawnItems_{{ this.get_name() }} =
+                    {{ this.feature_group.get_name() }};
+            {%- else %}
+                // FeatureGroup is to store editable layers.
+                var drawnItems_{{ this.get_name() }} =
+                    new L.featureGroup().addTo(
+                        {{ this._parent.get_name() }}
+                    );
+            {%- endif %}
+            /* The global varianble below is needed to prevent streamlit-folium
+               from barfing :-(
+            */
+            var drawnItems = drawnItems_{{ this.get_name() }};
+
+            {{this._parent.get_name()}}.pm.addControls(
+                {{this.options|tojavascript}}
+            )
+            drawnItems_{{ this.get_name() }}.eachLayer(function(layer){
+                L.PM.reInitLayer(layer);
+                {%- for event, handler in this.on.items()   %}
+                layer.on(
+                    "{{event}}",
+                    {{handler}}
+                );
+                {%- endfor %}
+            });
+
+            {{ this._parent.get_name() }}.on("pm:create", function(e) {
+                var layer = e.layer,
+                    type = e.layerType;
+
+                {%- for event, handler in this.on.items()   %}
+                layer.on(
+                    "{{event}}",
+                    {{handler}}
+                );
+                {%- endfor %}
+                drawnItems_{{ this.get_name() }}.addLayer(layer);
+            });
+            {{ this._parent.get_name() }}.on("pm:remove", function(e) {
+                var layer = e.layer,
+                    type = e.layerType;
+                drawnItems_{{ this.get_name() }}.removeLayer(layer);
+            });
+
+        {% endmacro %}
+        """
+    )
+
+    default_js = [
+        (
+            "leaflet_geoman_js",
+            "https://unpkg.com/@geoman-io/leaflet-geoman-free@latest/dist/leaflet-geoman.js",
+        )
+    ]
+    default_css = [
+        (
+            "leaflet_geoman_css",
+            "https://unpkg.com/@geoman-io/leaflet-geoman-free@latest/dist/leaflet-geoman.css",
+        )
+    ]
+
+    def __init__(
+        self,
+        position="topleft",
+        feature_group=None,
+        on=None,
+        **kwargs,
+    ):
+        super().__init__()
+        self._name = "GeoMan"
+        self.feature_group = feature_group
+        self.on = on or {}
+        self.options = remove_empty(
+            position=position, layer_group=feature_group, **kwargs
+        )

tests/plugins/test_geoman.py

@@ -0,0 +1,29 @@
+"""
+Test GeoMan
+----------------
+
+"""
+
+import folium
+from folium import plugins
+from folium.template import Template
+from folium.utilities import normalize
+
+
+def test_geoman():
+    m = folium.Map([47, 3], zoom_start=1)
+    fs = plugins.GeoMan().add_to(m)
+
+    out = normalize(m._parent.render())
+
+    # verify that the GeoMan plugin was added to
+    # the map
+    tmpl = Template(
+        """
+        {{this._parent.get_name()}}.pm.addControls(
+            {{this.options|tojavascript}}
+        )
+    """
+    )
+
+    assert normalize(tmpl.render(this=fs)) in out