plugins: add fullscreen plugin

Author: sanga

examples/fullscreen_plugin_example.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+import folium
+
+from folium.plugins import Fullscreen
+
+m = folium.Map(location=[41.9, -97.3], zoom_start=4)
+Fullscreen().add_to(m)
+
+m.save(outfile='fullscreen.html')

folium/plugins/__init__.py

@@ -13,11 +13,13 @@
 from .timestamped_geo_json import TimestampedGeoJson
 from .heat_map import HeatMap
 from .image_overlay import ImageOverlay
+from .fullscreen import Fullscreen
 
 __all__ = ['MarkerCluster',
            'ScrollZoomToggler',
            'Terminator',
            'BoatMarker',
            'TimestampedGeoJson',
            'HeatMap',
-           'ImageOverlay']
+           'ImageOverlay',
+           'Fullscreen']

folium/plugins/fullscreen.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+"""
+Fullscreen
+--------------
+
+https://github.com/brunob/leaflet.fullscreen
+
+Adds fullscreen button to your maps.
+"""
+from jinja2 import Template
+
+from branca.element import MacroElement, Figure, JavascriptLink, CssLink
+
+
+class Fullscreen(MacroElement):
+    """
+    Adds a fullscreen button to your map.
+
+    Note: does not work from within an iframe, and because of this, does not
+    work in jupyter notebook
+    """
+
+    def __init__(self):
+        """Add button to take your Folium map fullscreen"""
+        super(Fullscreen, self).__init__()
+        self._name = 'Fullscreen'
+
+        self._template = Template("""
+        {% macro script(this, kwargs) %}
+            L.control.fullscreen().addTo({{this._parent.get_name()}});
+            {{this._parent.get_name()}}.on('enterFullscreen', function(){
+                console.log('entered fullscreen');
+            });
+
+        {% endmacro %}
+        """)  # noqa
+
+    def render(self, **kwargs):
+        super(Fullscreen, self).render()
+
+        figure = self.get_root()
+        assert isinstance(figure, Figure), ("You cannot render this Element "
+                                            "if it's not in a Figure.")
+
+        figure.header.add_children(
+            JavascriptLink(
+                "https://cdnjs.cloudflare.com/ajax/libs/leaflet.fullscreen/1.4.2/Control.FullScreen.min.js"),  # noqa
+            name='Control.Fullscreen.js'
+        )
+
+        figure.header.add_children(
+            CssLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.fullscreen/1.4.2/Control.FullScreen.min.css"),  # noqa
+            name='Control.FullScreen.css'
+        )

tests/plugins/test_fullscreen.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+"""
+Test Fullscreen
+-----------------------
+"""
+from jinja2 import Template
+
+import folium
+from folium import plugins
+
+
+def test_fullscreen():
+    data = {
+        "type": "FeatureCollection",
+        "features": [
+                {
+                    "type": "Feature",
+                    "geometry": {
+                        "type": "Point",
+                        "coordinates": [0, 0],
+                        },
+                    "properties": {}
+                    }
+            ],
+        }
+
+    m = folium.Map([47, 3], zoom_start=1)
+    fs = plugins.Fullscreen()
+    m.add_children(fs)
+    m._repr_html_()
+
+    out = m._parent.render()
+
+    # verify that the fullscreen control was rendered
+    assert 'L.control.fullscreen().addTo' in out
+