Merge pull request #468 from qingkaikong/add_options_to_fullscreen_plugin

add options to fullscreen plugin

Author: ocefpaf

examples/fullscreen_plugin_example.py

@@ -4,6 +4,7 @@
 from folium.plugins import Fullscreen
 
 m = folium.Map(location=[41.9, -97.3], zoom_start=4)
-Fullscreen().add_to(m)
+Fullscreen(position='topright', title='Expand me', titleCancel='Exit me',
+           forceSeparateButton=True).add_to(m)
 
 m.save(outfile='fullscreen.html')

folium/plugins/fullscreen.py

@@ -15,16 +15,42 @@
 class Fullscreen(MacroElement):
     """
     Adds a fullscreen button to your map.
+
+    Parameters
+    ----------
+    position : str
+          change the position of the button can be:
+          'topleft', 'topright', 'bottomright' or 'bottomleft'
+          default: 'topleft'
+    title : str
+          change the title of the button,
+          default: 'Full Screen'
+    titleCancel : str
+          change the title of the button when fullscreen is on,
+          default: 'Exit Full Screen'
+    forceSeparateButton : boolean
+          force seperate button to detach from zoom buttons,
+          default: False
     """
 
-    def __init__(self):
+    def __init__(self, position='topleft', title='Full Screen',
+                 titleCancel='Exit Full Screen', forceSeparateButton=False):
         """Add button to take your Folium map fullscreen"""
         super(Fullscreen, self).__init__()
         self._name = 'Fullscreen'
+        self.position = position
+        self.title = title
+        self.titleCancel = titleCancel
+        self.forceSeparateButton = str(forceSeparateButton).lower()
 
         self._template = Template("""
         {% macro script(this, kwargs) %}
-            L.control.fullscreen().addTo({{this._parent.get_name()}});
+            L.control.fullscreen({
+                position: '{{this.position}}',
+                title: '{{this.title}}',
+                titleCancel: '{{this.titleCancel}}',
+                forceSeparateButton: {{this.forceSeparateButton}},
+                }).addTo({{this._parent.get_name()}});
             {{this._parent.get_name()}}.on('enterFullscreen', function(){
                 console.log('entered fullscreen');
             });

tests/plugins/test_fullscreen.py

@@ -5,6 +5,7 @@
 """
 import folium
 from folium import plugins
+from jinja2 import Template
 
 
 def test_fullscreen():
@@ -16,4 +17,16 @@ def test_fullscreen():
     out = m._parent.render()
 
     # verify that the fullscreen control was rendered
-    assert 'L.control.fullscreen().addTo' in out
+    tmpl = Template("""
+        L.control.fullscreen({
+            position: '{{this.position}}',
+            title: '{{this.title}}',
+            titleCancel: '{{this.titleCancel}}',
+            forceSeparateButton: {{this.forceSeparateButton}},
+            }).addTo({{this._parent.get_name()}});
+        {{this._parent.get_name()}}.on('enterFullscreen', function(){
+            console.log('entered fullscreen');
+        });
+    """)
+
+    assert ''.join(tmpl.render(this=fs).split()) in ''.join(out.split())