Merge pull request #437 from sanga/fullscreen_plugin

plugins: add fullscreen plugin

Author: ocefpaf

.gitignore

@@ -50,5 +50,8 @@ ENV
 data.png
 map.html
 
+# example outputs
+examples/*.html
+
 # documentation builds
 docs/_build

CHANGES.txt

@@ -1,3 +1,8 @@
+0.3.0
+~~~~~
+
+- Add fullscreen plugin (sanga #437)
+
 0.2.1
 ~~~~~
 Bugfix release

examples/base_map.py

@@ -5,9 +5,9 @@
 
 # Standard OSM.
 map_osm = folium.Map(location=[45.5236, -122.6750])
-map_osm.create_map(path='osm.html')
+map_osm.save(outfile='osm.html')
 
 # Stamen Toner.
 stamen = folium.Map(location=[45.5236, -122.6750], tiles='Stamen Toner',
                     zoom_start=13)
-stamen.create_map(path='stamen_toner.html')
+stamen.save(outfile='stamen_toner.html')

examples/choropleth_counties.py

@@ -38,7 +38,7 @@ def set_id(fips):
                key_on='feature.id',
                fill_color='YlOrRd', fill_opacity=0.7, line_opacity=0.3,
                topojson='objects.us_counties_20m')
-map_1.create_map(path='map_1.html')
+map_1.save(outfile='map_1.html')
 
 # Unemployment with custom defined scale.
 map_2 = folium.Map(location=[40, -99], zoom_start=4)
@@ -49,7 +49,7 @@ def set_id(fips):
                fill_color='YlGnBu', line_opacity=0.3,
                legend_name='Unemployment Rate 2011 (%)',
                topojson='objects.us_counties_20m')
-map_2.create_map(path='map_2.html')
+map_2.save(outfile='map_2.html')
 
 # Median Household income.
 map_3 = folium.Map(location=[40, -99], zoom_start=4)
@@ -59,4 +59,4 @@ def set_id(fips):
                fill_color='PuRd', line_opacity=0.3,
                legend_name='Median Household Income 2011 ($)',
                topojson='objects.us_counties_20m')
-map_3.create_map(path='map_3.html')
+map_3.save(outfile='map_3.html')

examples/choropleth_states.py

@@ -18,7 +18,7 @@
                 key_on='feature.id',
                 fill_color='YlGn', fill_opacity=0.7, line_opacity=0.2,
                 legend_name='Unemployment Rate (%)')
-states.create_map(path='us_state_map.html')
+states.save(outfile='us_state_map.html')
 
 # Let's define our own scale and change the line opacity.
 states2 = folium.Map(location=[48, -102], zoom_start=3)
@@ -29,4 +29,4 @@
                  fill_color='BuPu', fill_opacity=0.7, line_opacity=0.5,
                  legend_name='Unemployment Rate (%)',
                  reset=True)
-states2.create_map(path='us_state_map_2.html')
+states2.save(outfile='us_state_map_2.html')

examples/folium_vincent_markers.py

@@ -45,4 +45,4 @@
                         radius=12, popup=(vis2, 'vis2.json'))
 buoy_map.polygon_marker(location=[46.216, -124.1280], fill_color='#43d9de',
                         radius=12, popup=(vis3, 'vis3.json'))
-buoy_map.create_map(path='NOAA_buoys.html')
+buoy_map.save(outfile='NOAA_buoys.html')

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')

examples/line_example.py

@@ -28,4 +28,4 @@
 m = folium.Map(location=[41.9, -97.3], zoom_start=4)
 m.line(coordinates, line_color='#FF0000', line_weight=5)
 
-m.create_map(path='line_example.html')
+m.save(outfile='line_example.html')

examples/markers.py

@@ -8,7 +8,7 @@
                    tiles='Stamen Terrain')
 map_1.simple_marker([45.3288, -121.6625], popup='Mt. Hood Meadows')
 map_1.simple_marker([45.3311, -121.7113], popup='Timberline Lodge')
-map_1.create_map(path='mthood.html')
+map_1.save(outfile='mthood.html')
 
 # Circle Markers with Stamen Toner.
 map_2 = folium.Map(location=[45.5236, -122.6750], tiles='Stamen Toner',
@@ -17,20 +17,20 @@
 map_2.circle_marker(location=[45.5215, -122.6261], radius=500,
                     popup='Laurelhurst Park', line_color='#3186cc',
                     fill_color='#3186cc')
-map_2.create_map(path='portland.html')
+map_2.save(outfile='portland.html')
 
 # Lat/Lng popovers.
 map_3 = folium.Map(location=[46.1991, -122.1889], tiles='Stamen Terrain',
                    zoom_start=13)
 map_3.lat_lng_popover()
-map_3.create_map(path='sthelens.html')
+map_3.save(outfile='sthelens.html')
 
 # Click for marker.
 map_4 = folium.Map(location=[46.8527, -121.7649], tiles='Stamen Terrain',
                    zoom_start=13)
 map_4.simple_marker(location=[46.8354, -121.7325], popup='Camp Muir')
 map_4.click_for_marker(popup='Waypoint')
-map_4.create_map(path='mtrainier.html')
+map_4.save(outfile='mtrainier.html')
 
 # Polygon markers.
 map_5 = folium.Map(location=[45.5236, -122.6750], zoom_start=13)
@@ -42,4 +42,4 @@
                      fill_color='#769d96', num_sides=6, radius=10)
 map_5.polygon_marker(location=[45.5318, -122.6745], popup='Broadway Bridge',
                      fill_color='#769d96', num_sides=8, radius=10)
-map_5.create_map(path='bridges.html')
+map_5.save(outfile='bridges.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,51 @@
+# -*- 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.
+    """
+
+    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,19 @@
+# -*- coding: utf-8 -*-
+"""
+Test Fullscreen
+-----------------------
+"""
+import folium
+from folium import plugins
+
+
+def test_fullscreen():
+    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