Added default options to tile_layer

Author: ozak

folium/folium.py

@@ -90,13 +90,14 @@ def __init__(self, location=None, width='100%', height='100%',
 
         Examples
         --------
-        >>>map = folium.Map(location=[45.523, -122.675], width=750, height=500)
-        >>>map = folium.Map(location=[45.523, -122.675],
-                            tiles='Mapbox Control Room')
-        >>>map = folium.Map(location=(45.523, -122.675), max_zoom=20,
-                            tiles='Cloudmade', API_key='YourKey')
-        >>>map = folium.Map(location=[45.523, -122.675], zoom_start=2,
-                            tiles=('http://{s}.tiles.mapbox.com/v3/'
+        >>> map = folium.Map(location=[45.523, -122.675], width=750,
+        ...                  height=500)
+        >>> map = folium.Map(location=[45.523, -122.675],
+                             tiles='Mapbox Control Room')
+        >>> map = folium.Map(location=(45.523, -122.675), max_zoom=20,
+                             tiles='Cloudmade', API_key='YourKey')
+        >>> map = folium.Map(location=[45.523, -122.675], zoom_start=2,
+                             tiles=('http://{s}.tiles.mapbox.com/v3/'
                                     'mapbox.control-room/{z}/{x}/{y}.png'),
                             attr='Mapbox attribution')
 
@@ -209,24 +210,46 @@ def __init__(self, location=None, width='100%', height='100%',
         self.template_vars.setdefault('image_layers', [])
 
     @iter_obj('simple')
-    def add_tile_layer(self, tile_name=None, tile_url=None, active=False):
-        """Adds a simple tile layer.
+    def add_tile_layer(self, tile_name=None, tile_url=None, **kw):
+        """
+        Adds a simple tile layer.
 
         Parameters
         ----------
         tile_name: string
             name of the tile layer
         tile_url: string
             url location of the tile layer
-        active: boolean
-            should the layer be active when added
+
+        For the available options see:
+            http://leafletjs.com/reference.html#tilelayer
+
         """
+        # Same defaults.
+        tms = kw.pop('tms', 'false')
+        minZoom = kw.pop('minZoom', 0)
+        opacity = kw.pop('opacity', 1)
+        maxZoom = kw.pop('maxZoom', 18)
+        noWrap = kw.pop('noWrap', 'false')
+        zoomOffset = kw.pop('zoomOffset', 0)
+        zoomReverse = kw.pop('zoomReverse', 'false')
+        continuousWorld = kw.pop('continuousWorld', 'false')
+
         if tile_name not in self.added_layers:
             tile_name = tile_name.replace(" ", "_")
             tile_temp = self.env.get_template('tile_layer.js')
-
-            tile = tile_temp.render({'tile_name': tile_name,
-                                     'tile_url': tile_url})
+            tile = tile_temp.render({
+                'tile_name': tile_name,
+                'tile_url': tile_url,
+                'minZoom': minZoom,
+                'maxZoom': maxZoom,
+                'tms': str(tms).lower(),
+                'continuousWorld': str(continuousWorld).lower(),
+                'noWrap': str(noWrap).lower(),
+                'zoomOffset': zoomOffset,
+                'zoomReverse': str(zoomReverse).lower(),
+                'opacity': opacity,
+                })
 
             self.template_vars.setdefault('tile_layers', []).append((tile))
 
@@ -305,8 +328,8 @@ def simple_marker(self, location=None, popup=None,
 
         Example
         -------
-        >>>map.simple_marker(location=[45.5, -122.3], popup='Portland, OR')
-        >>>map.simple_marker(location=[45.5, -122.3], popup=(vis, 'vis.json'))
+        >>> map.simple_marker(location=[45.5, -122.3], popup='Portland, OR')
+        >>> map.simple_marker(location=[45.5, -122.3], popup=(vis, 'vis.json'))
 
         """
         count = self.mark_cnt['simple']
@@ -364,8 +387,8 @@ def line(self, locations,
 
         Example
         -------
-        >>>map.line(locations=[(45.5, -122.3), (42.3, -71.0)])
-        >>>map.line(locations=[(45.5, -122.3), (42.3, -71.0)],
+        >>> map.line(locations=[(45.5, -122.3), (42.3, -71.0)])
+        >>> map.line(locations=[(45.5, -122.3), (42.3, -71.0)],
                     line_color='red', line_opacity=1.0)
 
         """
@@ -409,7 +432,6 @@ def multiline(self, locations, line_color=None, line_opacity=None,
 
         Example
         -------
-        # FIXME: Add another example.
         >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
                                    [(45.5237, -122.675), (45.5237, -122.675)],
                                    [(45.5238, -122.675), (45.5238, -122.675)]])
@@ -467,9 +489,9 @@ def circle_marker(self, location=None, radius=500, popup=None,
 
         Example
         -------
-        >>>map.circle_marker(location=[45.5, -122.3],
+        >>> map.circle_marker(location=[45.5, -122.3],
                              radius=1000, popup='Portland, OR')
-        >>>map.circle_marker(location=[45.5, -122.3],
+        >>> map.circle_marker(location=[45.5, -122.3],
                              radius=1000, popup=(bar_chart, 'bar_data.json'))
 
         """
@@ -584,7 +606,7 @@ def click_for_marker(self, popup=None):
 
         Example
         -------
-        >>>map.click_for_marker(popup='Your Custom Text')
+        >>> map.click_for_marker(popup='Your Custom Text')
 
         """
         latlng = '"Latitude: " + lat + "<br>Longitude: " + lng '

folium/templates/leaflet-dvf.markers.min.js

@@ -1 +1,10 @@
-var {{ tile_name }} = L.tileLayer('{{ tile_url }}');
+var {{ tile_name }} = L.tileLayer('{{ tile_url }}',{
+                            'minZoom': {{minZoom}},
+                            'maxZoom': {{maxZoom}},
+                            'tms': {{tms}},
+                            'continuousWorld': {{continuousWorld}},
+                            'noWrap': {{noWrap}},
+                            'zoomOffset': {{zoomOffset}},
+                            'zoomReverse': {{zoomReverse}},
+                            'opacity': {{opacity}} 
+                            });

folium/templates/tile_layer.js

@@ -138,6 +138,41 @@ def test_wms_layer(self):
                                'wms_transparent': 'true'})
         assert map.template_vars['wms_layers'][0] == wms
 
+    def test_add_tile_layer(self):
+        """Test add_layer URLs."""
+
+        map = folium.Map(location=[44, -73], zoom_start=3)
+        tile_name = "Temperature"
+        tile_url = 'http://gis.srh.noaa.gov/arcgis/services/NDFDTemps/'
+        tile_url += 'MapServer/WMSServer'
+        minZoom = 1
+        maxZoom = 5
+        tms = True
+        continuousWorld = False
+        noWrap = True
+        zoomOffset = 1
+        zoomReverse = True
+        opacity = 2
+        map.add_tile_layer(tile_name=tile_name, tile_url=tile_url, active=True,
+                           minZoom=minZoom, maxZoom=maxZoom, tms=tms,
+                           continuousWorld=continuousWorld, noWrap=noWrap,
+                           zoomOffset=zoomOffset, zoomReverse=zoomReverse,
+                           opacity=opacity, attribution='Leaflet')
+        tile_temp = self.env.get_template('tile_layer.js')
+        tile = tile_temp.render({
+                          'tile_name': tile_name,
+                          'tile_url': tile_url,
+                          'minZoom': minZoom,
+                          'maxZoom': maxZoom,
+                          'tms': str(tms).lower(),
+                          'continuousWorld': str(continuousWorld).lower(),
+                          'noWrap': str(noWrap).lower(),
+                          'zoomOffset': zoomOffset,
+                          'zoomReverse': str(zoomReverse).lower(),
+                          'opacity': opacity,
+                      })
+        assert map.template_vars['tile_layers'][0] == tile
+
     def test_simple_marker(self):
         """Test simple marker addition."""