Put timestamped_geo_json plugin into a template

Author: Martin Journois

folium/plugins/plugin.py

@@ -10,7 +10,7 @@
 from uuid import uuid4
 
 from jinja2 import Environment, PackageLoader
-ENV = Environment(loader=PackageLoader('folium', 'templates'))
+ENV = Environment(loader=PackageLoader('folium', 'plugins'))
 
 class Plugin(object):
     """Basic plugin object that does nothing.

folium/plugins/timestamped_geo_json.py

@@ -70,6 +70,7 @@ def __init__(self, data, transition_time=200, loop=True, auto_play=True):
         """
         super(TimestampedGeoJson, self).__init__()
         self.plugin_name = 'TimestampedGeoJson'
+        self.template = self.env.get_template('timestamped_geo_json.template')
         if 'read' in dir(data):
             self.data = data.read()
         elif type(data) is dict:
@@ -82,34 +83,11 @@ def __init__(self, data, transition_time=200, loop=True, auto_play=True):
 
     def render_header(self, nb):
         """Generates the header part of the plugin."""
-        return """
-        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/default.min.css">
-        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.0/jquery.min.js"></script>
-        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.10.2/jquery-ui.min.js"></script>
-
-        <!-- iso8601 -->
-        <script type="text/javascript" src="https://raw.githubusercontent.com/nezasa/iso8601-js-period/master/iso8601.min.js"></script>
-        
-        <!-- leaflet.timedimension.min.js -->
-        <script type="text/javascript" src="https://raw.githubusercontent.com/socib/Leaflet.TimeDimension/master/dist/leaflet.timedimension.min.js"></script>
-
-        <!-- leaflet.timedimension.control.min.css -->
-        <link rel="stylesheet" href="http://apps.socib.es/Leaflet.TimeDimension/dist/leaflet.timedimension.control.min.css" />
-        """ if nb==0 else ""
+        header = self.template.module.__dict__.get('header',None)
+        assert header is not None, "This template must have a 'header' macro."
+        return header(nb)
     def render_js(self, nb):
         """Generates the Javascript part of the plugin."""
-        out = """
-            map.timeDimension = L.timeDimension();
-        map.timeDimensionControl = L.control.timeDimension({
-            position: 'bottomleft',
-            autoPlay: %s,
-            playerOptions: {transitionTime: %i,loop: %s}
-            });
-        map.addControl(map.timeDimensionControl);
-        """%(str(self.auto_play).lower(),self.transition_time,str(self.loop).lower()) if nb==0 else ""
-
-        out += """
-        var tsgeojson_%i = L.timeDimension.layer.geoJson(L.geoJson(%s),
-            {updateTimeDimension: true,addlastPoint: true}).addTo(map);
-        """ % (nb, self.data)
-        return out
+        js = self.template.module.__dict__.get('js',None)
+        assert js is not None, "This template must have a 'js' macro."
+        return js(nb,self)

folium/plugins/timestamped_geo_json.template

@@ -0,0 +1,31 @@
+{% macro header(nb) %}
+    {% if nb==0 %}
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/default.min.css">
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.0/jquery.min.js"></script>
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.10.2/jquery-ui.min.js"></script>
+
+        <!-- iso8601 -->
+        <script type="text/javascript" src="https://raw.githubusercontent.com/nezasa/iso8601-js-period/master/iso8601.min.js"></script>
+
+        <!-- leaflet.timedimension.min.js -->
+        <script type="text/javascript" src="https://raw.githubusercontent.com/socib/Leaflet.TimeDimension/master/dist/leaflet.timedimension.min.js"></script>
+
+        <!-- leaflet.timedimension.control.min.css -->
+        <link rel="stylesheet" href="http://apps.socib.es/Leaflet.TimeDimension/dist/leaflet.timedimension.control.min.css" />
+    {% endif %}
+{% endmacro %}
+
+{% macro js(nb,self) %}
+    {% if nb==0 %}
+        map.timeDimension = L.timeDimension();
+        map.timeDimensionControl = L.control.timeDimension({
+            position: 'bottomleft',
+            autoPlay: {{'true' if self.auto_play else 'false'}},
+            playerOptions: {transitionTime: {{self.transition_time}},loop: {{'true' if self.loop else 'false'}}}
+            });
+        map.addControl(map.timeDimensionControl);
+    {% endif %}
+
+    var tsgeojson_{{nb}} = L.timeDimension.layer.geoJson(L.geoJson({{self.data}}),
+        {updateTimeDimension: true,addlastPoint: true}).addTo(map);
+{% endmacro %}