Handle several additions of the same plugin

Author: Martin Journois

folium/folium.py

@@ -661,7 +661,7 @@ def add_plugin(self, plugin):
                 A plugin to be added to the map. It has to implement the methods
                 `render_html`, `render_css` and `render_js`.
         """
-        self.plugins[plugin.object_name] = plugin
+        self.plugins.setdefault(plugin.plugin_name,[]).append(plugin)
 
     def _auto_bounds(self):
         if 'fit_bounds' in self.template_vars:

folium/plugins/boat_marker.py

@@ -34,22 +34,22 @@ def __init__(self, position=None, heading=0, wind_heading=None, wind_speed=0, **
         self.wind_speed = wind_speed
         self.kwargs = kwargs.copy()
 
-    def render_header(self):
+    def render_header(self, nb):
         """Generates the HTML part of the plugin."""
         return """
-        <script src="https://tomaszbrue.github.io/leaflet.boatmarker/js/leaflet.boatmarker.min.js"></script>
-        """
+            <script src="https://tomaszbrue.github.io/leaflet.boatmarker/js/leaflet.boatmarker.min.js"></script>
+            """  if nb==0 else ""
 
-    def render_js(self):
+    def render_js(self, nb):
         """Generates the Javascript part of the plugin."""
         kwargs_str =  "{%s}" % ",".join(["%s : %s" % (key,json.dumps(val)) for (key,val) in self.kwargs.items()])
         position_str = "map.getCenter()" if self.position is None else "[%.12f,%.12f]"%self.position
-        out = 'var boatMarker = L.boatMarker(%s, %s).addTo(map);' % (position_str,kwargs_str)
+        out = 'var boatMarker_%s = L.boatMarker(%s, %s).addTo(map);' % (nb,position_str,kwargs_str)
 
         if self.wind_heading is None:
-            out += "boatMarker.setHeading(%s);" % int(self.heading)
+            out += "boatMarker_%s.setHeading(%s);" % (nb,int(self.heading))
         else:
-            out += "boatMarker.setHeadingWind(%s, %s, %s);"%(int(self.heading),
+            out += "boatMarker_%s.setHeadingWind(%s, %s, %s);"%(nb,int(self.heading),
                                                              int(self.wind_speed),
                                                              int(self.wind_heading),
                                                              )

folium/plugins/marker_cluster.py

@@ -19,15 +19,15 @@ def __init__(self, data):
         self.plugin_name = 'MarkerCluster'
         self.data = [tuple(x) for x in data]
 
-    def render_header(self):
+    def render_header(self, nb):
         """Generates the HTML part of the plugin."""
         return """
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.css" />
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.Default.css" />
         <script src="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/leaflet.markercluster.js"></script>
-        """
+        """ if nb==0 else ""
 
-    def render_js(self):
+    def render_js(self, nb):
         """Generates the Javascript part of the plugin."""
         out = """
         var addressPoints = """+json.dumps(self.data)+""";

folium/plugins/plugin.py

@@ -10,17 +10,17 @@ def __init__(self):
         self.plugin_name = 'Plugin'
         self.object_name = uuid4().hex
 
-    def render_html(self):
+    def render_html(self, nb):
         """Generates the HTML part of the plugin."""
         return ""
 
-    def render_css(self):
+    def render_css(self, nb):
         """Generates the CSS part of the plugin."""
         return ""
 
-    def render_js(self):
+    def render_js(self, nb):
         """Generates the Javascript part of the plugin."""
         return ""
-    def render_header(self):
+    def render_header(self, nb):
         """Generates the Header part of the plugin."""
         return ""

folium/plugins/scroll_zoom_toggler.py

@@ -17,13 +17,14 @@ def __init__(self, zoom_enabled=False):
         self.plugin_name = 'ScrollZoomToggler'
         self.zoom_enabled = zoom_enabled
 
-    def render_html(self):
+    def render_html(self, nb):
         """Generates the HTML part of the plugin."""
         return """<img id="{}_{}" alt="scroll"
        src="https://cdnjs.cloudflare.com/ajax/libs/ionicons/1.5.2/png/512/arrow-move.png"
-       onclick="toggleScroll()"></img>""".format(self.plugin_name,self.object_name)
+       onclick="toggleScroll()"></img>""".format(self.plugin_name,self.object_name)\
+          if nb==0 else ""
 
-    def render_css(self):
+    def render_css(self, nb):
         """Generates the CSS part of the plugin."""
         return """
         #"""+self.plugin_name+'_'+self.object_name+""" {
@@ -37,9 +38,9 @@ def render_css(self):
             line-height:35px;
             vertical-align: middle;
             }
-            """
+            """ if nb==0 else ""
 
-    def render_js(self):
+    def render_js(self, nb):
         """Generates the Javascript part of the plugin."""
         out = """
         map.scrollEnabled = true;
@@ -57,4 +58,4 @@ def render_js(self):
         """
         if not self.zoom_enabled:
             out += "\n        toggleScroll();"
-        return out
+        return out if nb==0 else ""

folium/plugins/terminator.py

@@ -21,10 +21,10 @@ def __init__(self):
         super(Terminator, self).__init__()
         self.plugin_name = 'Terminator'
 
-    def render_header(self):
+    def render_header(self, nb):
         """Generates the header part of the plugin."""
-        return '<script type="text/javascript">'+_terminator_script+'</script>'
+        return '<script type="text/javascript">'+_terminator_script+'</script>' if nb==0 else ""
 
-    def render_js(self):
+    def render_js(self, nb):
         """Generates the Javascript part of the plugin."""
-        return "L.terminator().addTo(map);"
+        return "L.terminator().addTo(map);" if nb==0 else ""

folium/templates/fol_template.html

@@ -24,7 +24,11 @@
    <link rel="stylesheet" href="https://birdage.github.io/Leaflet.awesome-markers/dist/leaflet.awesome.rotate.css">
 
     {% for name, plugin in plugins.items() %}
-        {{plugin.render_header()}}
+        {% set plugin_nb = 0 %}
+        {% for plugin_object in plugin %}
+            {{plugin_object.render_header(plugin_nb)}}
+            {% set plugin_nb = plugin_nb +1 %}
+        {% endfor %}
     {% endfor %}
 
    {{ dvf_js }}
@@ -50,7 +54,11 @@
       }
 
     {% for name, plugin in plugins.items() %}
-        {{plugin.render_css()}}
+        {% set plugin_nb = 0 %}
+        {% for plugin_object in plugin %}
+            {{plugin_object.render_css(plugin_nb)}}
+            {% set plugin_nb = plugin_nb +1 %}
+        {% endfor %}
     {% endfor %}
 
    </style>
@@ -61,7 +69,11 @@
    <div class="folium-map" id="{{ map_id }}" {{ size }}></div>
 
     {% for name, plugin in plugins.items() %}
-        {{plugin.render_html()}}
+        {% set plugin_nb = 0 %}
+        {% for plugin_object in plugin %}
+            {{plugin_object.render_html(plugin_nb)}}
+            {% set plugin_nb = plugin_nb +1 %}
+        {% endfor %}
     {% endfor %}
 
    <script>
@@ -164,7 +176,11 @@
 {% if fit_bounds %}{{ fit_bounds }}{% endif %}
 
     {% for name, plugin in plugins.items() %}
-        {{plugin.render_js()}}
+        {% set plugin_nb = 0 %}
+        {% for plugin_object in plugin %}
+            {{plugin_object.render_js(plugin_nb)}}
+            {% set plugin_nb = plugin_nb +1 %}
+        {% endfor %}
     {% endfor %}
 
    </script>