Merge pull request #348 from ocefpaf/wms_docs_option

WMS options

Author: BibMartin

folium/features.py

@@ -23,45 +23,57 @@ class WmsTileLayer(Layer):
 
     Parameters
     ----------
-    url: str
+    url : str
         The url of the WMS server.
-    format: str, default None
+    name : string, default None
+        The name of the Layer, as it will appear in LayerControls
+    layers : str, default None
+        The names of the layers to be displayed.
+    styles : str, default None
+        Comma-separated list of WMS styles.
+    format : str, default None
         The format of the service output.
         Ex: 'iamge/png'
-    layers: str, default None
-        The names of the layers to be displayed.
     transparent: bool, default True
         Whether the layer shall allow transparency.
-    attr: str, default None
+    version : str, default '1.1.1'
+        Version of the WMS service to use.
+    attr : str, default None
         The attribution of the service. Will be displayed in the bottom right corner.
-    name : string, default None
-        The name of the Layer, as it will appear in LayerControls
     overlay : bool, default False
         Adds the layer as an optional overlay (True) or the base layer (False).
     control : bool, default True
         Whether the Layer will be included in LayerControls
+
+    For more information see:
+    http://leafletjs.com/reference.html#tilelayer-wms
+
     """
-    def __init__(self, url, format=None, layers=None,
-                 transparent=True, attr=None,
-                 name=None, overlay=True, control=True):
+    def __init__(self, url, name=None, layers=None, styles=None, format=None,
+                 transparent=True, version='1.1.1', attr=None, overlay=True,
+                 control=True):
         super(WmsTileLayer, self).__init__(overlay=overlay, control=control, name=name)
-        self._name = 'WmsTileLayer'
-        self.tile_name = name if name is not None else 'WmsTileLayer_'+self._id
         self.url = url
-        self.format = format
-        self.layers = layers
+        self.attribution = attr if attr is not None else ''
+        # Options.
+        self.layers = layers if layers else ''
+        self.styles = styles if styles else ''
+        self.format = format if format else 'image/jpeg'
         self.transparent = transparent
-        self.attr = attr
-
+        self.version = version
+        # FIXME: Should be map CRS!
+        # self.crs = crs if crs else 'null
         self._template = Template(u"""
         {% macro script(this, kwargs) %}
             var {{this.get_name()}} = L.tileLayer.wms(
                 '{{ this.url }}',
                 {
+                    layers:'{{ this.layers }}',
+                    styles: '{{ this.styles }}',
                     format:'{{ this.format }}',
                     transparent: {{ this.transparent.__str__().lower() }},
-                    layers:'{{ this.layers }}'
-                    {% if this.attr %}, attribution:'{{this.attr}}'{% endif %}
+                    version: '{{ this.version }}',
+                    {% if this.attribution %}, attribution:'{{this.attribution}}'{% endif %}
                     }
                 ).addTo({{this._parent.get_name()}});
 

tests/test_folium.py

@@ -139,33 +139,6 @@ def test_custom_tile(self):
         bounds = map.get_bounds()
         assert bounds == [[None, None], [None, None]], bounds
 
-    def test_wms_layer(self):
-        """Test WMS layer URLs."""
-
-        map = folium.Map(location=[44, -73], zoom_start=3)
-        wms_url = 'http://gis.srh.noaa.gov/arcgis/services/NDFDTemps/'
-        wms_url += 'MapServer/WMSServer'
-        wms_name = "Temperature"
-        wms_layers = 16
-        wms_format = "image/png"
-        map.add_wms_layer(wms_name=wms_name,
-                          wms_url=wms_url,
-                          wms_format=wms_format,
-                          wms_layers=wms_layers,
-                          wms_transparent=True)
-
-        wms_temp = self.env.get_template('wms_layer.js')
-        wms = wms_temp.render({'wms_name': map._children[wms_name].get_name(),
-                               'wms_url': wms_url,
-                               'wms_format': wms_format,
-                               'wms_layer_names': wms_layers,
-                               'wms_transparent': 'true'})
-        assert (''.join(wms.split())[:-1] in
-                ''.join(map.get_root().render().split()))
-
-        bounds = map.get_bounds()
-        assert bounds == [[None, None], [None, None]], bounds
-
     def test_feature_group(self):
         """Test FeatureGroup."""