Support multi_polyline

Author: scari

folium/folium.py

@@ -382,6 +382,58 @@ def line(self, locations,
                                                            add_line))
 
 
+    @iter_obj('multiline')
+    def multiline(self, locations,
+             line_color=None, line_opacity=None, line_weight=None):
+        '''Add a multiPolyline to the map with optional styles.
+
+        A multiPolyline is single layer that consists of several polylines that
+        share styling/popup.
+
+        Parameters
+        ----------
+        locations: list of lists of points (latitude, longitude)
+            Latitude and Longitude of line (Northing, Easting)
+        line_color: string, default Leaflet's default ('#03f')
+        line_opacity: float, default Leaflet's default (0.5)
+        line_weight: float, default Leaflet's default (5)
+
+        Note: If the optional styles are omitted, they will not be included
+        in the HTML output and will obtain the Leaflet defaults listed above.
+
+        Example
+        -------
+        >>>map.multiline(locations=[[(45.5236, -122.6750), (45.5236, -122.6751)],
+                                    [(45.5237, -122.6750), (45.5237, -122.6751)],
+                                    [(45.5238, -122.6750), (45.5238, -122.6751)]])
+        >>>map.multiline(locations=[[(45.5236, -122.6750), (45.5236, -122.6751)],
+                                    [(45.5237, -122.6750), (45.5237, -122.6751)],
+                                    [(45.5238, -122.6750), (45.5238, -122.6751)]],
+                                    line_color='red',
+                                    line_weight=2,
+                                    line_opacity=1.0)
+        '''
+
+        count = self.mark_cnt['multiline']
+
+        multiline_temp = self.env.get_template('multi_polyline.js')
+
+        multiline_opts = {'color': line_color,
+                'weight': line_weight,
+                'opacity': line_opacity}
+
+        varname = 'multiline_{}'.format(count)
+        multiline_rendered = multiline_temp.render({'multiline': varname,
+                                          'locations': locations,
+                                          'options': multiline_opts})
+
+        add_multiline = 'map.addLayer({});'.format(varname)
+
+        self.template_vars.setdefault('multilines', []).append((multiline_rendered,
+                                                           add_multiline))
+
+
+
     @iter_obj('circle')
     def circle_marker(self, location=None, radius=500, popup='Pop Text',
                       popup_on=True, line_color='black', fill_color='black',

folium/templates/fol_template.html

@@ -139,6 +139,11 @@
       {{ add_line }}
       {% endfor %}
 
+      {% for multiline, add_multiline in multilines %}
+      {{ multiline }}
+      {{ add_multiline }}
+      {% endfor %}
+
       {{ lat_lng_pop }}
 
       {{ click_pop }}

folium/templates/geojson_template.html

@@ -89,6 +89,11 @@
           {{ add_line }}
           {% endfor %}
 
+          {% for multiline, add_multiline in multilines %}
+          {{ multiline }}
+          {{ add_multiline }}
+          {% endfor %}
+
           {{ lat_lng_pop }}
 
           {{ click_pop }}

folium/templates/multi_polyline.js

@@ -0,0 +1,14 @@
+var latLngs = [
+{% for location in locations %}
+    [
+    {% for loc in location %}
+        [{{ loc[0] }}, {{ loc[1] }}],
+    {% endfor %}
+    ],
+{% endfor %}];
+
+var {{ multiline }} = L.multiPolyline(latLngs,{
+{% if options.color != None %}color: '{{ options.color }}',{% endif %}
+{% if options.weight != None %}weight: {{ options.weight }},{% endif %}
+{% if options.opacity != None %}opacity: {{ options.opacity }},{% endif %}
+});

tests/folium_tests.py

@@ -411,3 +411,27 @@ def test_create_map(self):
 
         # Test write
         map.create_map()
+
+    def test_multi_polyline(self):
+        '''Test multi_polyline'''
+
+        multiline_temp = self.env.get_template('multi_polyline.js')
+
+        multiline_opts = {'color': 'blue',
+                'weight': 2,
+                'opacity': 1}
+        locations = [
+                        [[45.5236, -122.6750], [45.5236, -122.6751]],
+                        [[45.5237, -122.6750], [45.5237, -122.6751]],
+                        [[45.5238, -122.6750], [45.5238, -122.6751]]
+                    ]
+        multiline_rendered = multiline_temp.render({'multiline': 'multiline_1',
+                                                    'locations': locations,
+                                                    'options': multiline_opts})
+
+        self.map.multiline(locations=locations,
+                           line_color=multiline_opts['color'],
+                           line_weight=multiline_opts['weight'],
+                           line_opacity=multiline_opts['opacity'])
+        assert self.map.template_vars['multilines'][0][0] == multiline_rendered
+