rename TimeDynamicGeoJson to TimeSliderChoropleth and fix some minor stuff

Author: ocefpaf

CHANGES.txt

@@ -7,7 +7,7 @@
 - Internal re-factor to reflect leaflet's organization (ocefpaf #725)
 - Added `tooltip` support to `Marker`s (ocefpaf #724)
 - Added `tooltip` support to all vector layers (ocefpaf #722)
-- Added TimeDynamicGeoJson plugin (halfdanrump #736)
+- Added `TimeSliderChoropleth` plugin (halfdanrump #736)
 
 API changes
 

examples/TilesExample.ipynb

@@ -343,7 +343,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.2"
+   "version": "3.6.3"
   }
  },
  "nbformat": 4,

examples/TimeSliderChoropleth.ipynb

@@ -22,9 +22,9 @@
 from folium.plugins.polyline_text_path import PolyLineTextPath
 from folium.plugins.scroll_zoom_toggler import ScrollZoomToggler
 from folium.plugins.terminator import Terminator
+from folium.plugins.time_slider_choropleth import TimeSliderChoropleth
 from folium.plugins.timestamped_geo_json import TimestampedGeoJson
 from folium.plugins.timestamped_wmstilelayer import TimestampedWmsTileLayers
-from folium.plugins.timedynamic_geo_json import TimeDynamicGeoJson
 
 __all__ = [
     'BoatMarker',
@@ -39,7 +39,7 @@
     'PolyLineTextPath',
     'ScrollZoomToggler',
     'Terminator',
+    'TimeSliderChoropleth',
     'TimestampedGeoJson',
     'TimestampedWmsTileLayers',
-    'TimeDynamicGeoJson'
     ]

folium/plugins/__init__.py

@@ -1,69 +1,30 @@
-"""
-module containing the class TimeDynamicGeoJson, which can be used to
-create choropleth maps with a time slider.
-"""
-from jinja2 import Template
-from branca.element import JavascriptLink, Figure
+import json
+
+from branca.element import Figure, JavascriptLink
+
 from folium.features import GeoJson
 
+from jinja2 import Template
+
 
-class TimeDynamicGeoJson(GeoJson):
-    """
-    Creates a GeoJson object for plotting into a Map.
-
-    Parameters
-    ----------
-    data: file, dict or str.
-        The GeoJSON data you want to plot.
-        * If file, then data will be read in the file and fully
-        embedded in Leaflet's JavaScript.
-        * If dict, then data will be converted to JSON and embedded
-        in the JavaScript.
-        * If str, then data will be passed to the JavaScript as-is.
-    style_function: function, default None
-        A function mapping a GeoJson Feature to a style dict.
-    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
-    smooth_factor: float, default None
-        How much to simplify the polyline on each zoom level. More means
-        better performance and smoother look, and less means more accurate
-        representation. Leaflet defaults to 1.0.
-
-    Examples
-    --------
-    >>> # Providing file that shall be embedded.
-    >>> GeoJson(open('foo.json'))
-    >>> # Providing filename that shall not be embedded.
-    >>> GeoJson('foo.json')
-    >>> # Providing dict.
-    >>> GeoJson(json.load(open('foo.json')))
-    >>> # Providing string.
-    >>> GeoJson(open('foo.json').read())
-
-    >>> # Provide a style_function that color all states green but Alabama.
-    >>> style_function = lambda x: {'fillColor': '#0000ff' if
-    ...                             x['properties']['name']=='Alabama' else
-    ...                             '#00ff00'}
-    >>> GeoJson(geojson, style_function=style_function)
-
-    """
-    def __init__(self, data, styledict, **kwargs):
-        super(TimeDynamicGeoJson, self).__init__(data, **kwargs)
-        assert isinstance(styledict, dict), 'styledict must be a dictionary'
+class TimeSliderChoropleth(GeoJson):
+    def __init__(self, data, styledict, name=None, overlay=True, control=True, **kwargs):
+        super(TimeSliderChoropleth, self).__init__(data, name=name, overlay=overlay, control=control)
+        if not isinstance(styledict, dict):
+            raise ValueError('styledict must be a dictionary, got {!r}'.format(styledict))
         for val in styledict.values():
-            assert isinstance(val, dict), 'each item in styledict must be a dictionary'
+            if not isinstance(val, dict):
+                raise ValueError('Each item in styledict must be a dictionary, got {!r}'.format(val))
+
 
-        self.styledict = styledict
+        # Make set of timestamps.
+        timestamps = set()
+        for feature in styledict.values():
+            timestamps.update(set(feature.keys()))
+        timestamps = sorted(list(timestamps))
 
-        # make set of timestamps
-        self.timestamps = set()
-        for feature in self.styledict.values():
-            self.timestamps.update(set(feature.keys()))
-        self.timestamps = sorted(list(self.timestamps))
+        self.timestamps = json.dumps(timestamps)
+        self.styledict = json.dumps(styledict, sort_keys=True, indent=2)
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
@@ -102,7 +63,9 @@ def __init__(self, data, styledict, **kwargs):
                         if (current_timestamp in style){
                             fillColor = style[current_timestamp]['color'];
                             opacity = style[current_timestamp]['opacity'];
-                            d3.selectAll('#feature-'+feature_id).attr('fill', fillColor).style('fill-opacity', opacity);
+                            d3.selectAll('#feature-'+feature_id
+                            ).attr('fill', fillColor)
+                            .style('fill-opacity', opacity);
                         }
                     }
                 }
@@ -155,21 +118,28 @@ def __init__(self, data, styledict, **kwargs):
                     ).addTo({{this._parent.get_name()}}
                 );
 
-        	{{this.get_name()}}.setStyle(function(feature) {feature.properties.style;});
+            {{this.get_name()}}.setStyle(function(feature) {feature.properties.style;});
 
                 {{ this.get_name() }}.eachLayer(function (layer) {
                     layer._path.id = 'feature-' + layer.feature.id;
                     });
 
-                d3.selectAll('path').attr('stroke', 'white').attr('stroke-width', 0.8).attr('stroke-dasharray', '5,5').attr('fill-opacity', 0);
+                d3.selectAll('path')
+                .attr('stroke', 'white')
+                .attr('stroke-width', 0.8)
+                .attr('stroke-dasharray', '5,5')
+                .attr('fill-opacity', 0);
                 fill_map();
 
             {% endmacro %}
             """)
 
     def render(self, **kwargs):
-        super(TimeDynamicGeoJson, self).render(**kwargs)
+        super(TimeSliderChoropleth, self).render(**kwargs)
         figure = self.get_root()
         assert isinstance(figure, Figure), ('You cannot render this Element '
                                             'if it is not in a Figure.')
-        figure.header.add_child(JavascriptLink('https://d3js.org/d3.v4.min.js'))  # noqa
+        figure.header.add_child(
+        JavascriptLink('https://d3js.org/d3.v4.min.js'),
+        name='d3v4'
+        )

folium/plugins/timedynamic_geo_json.py renamed to folium/plugins/time_slider_choropleth.py

@@ -2,7 +2,7 @@
 
 """
 Test FastMarkerCluster
-------------------
+----------------------
 """
 
 from __future__ import (absolute_import, division, print_function)

tests/plugins/test_fast_marker_cluster.py

@@ -1,32 +1,42 @@
 """
-tests for folium.plugins.TimeDynamicGeoJson
+tests TimeSliderChoropleth
+--------------------------
+
 """
+
+from __future__ import (absolute_import, division, print_function)
+
 import json
+
+from branca.colormap import linear
+
+import folium
+from folium.plugins import TimeSliderChoropleth
+
 import geopandas as gpd
-import pandas as pd
+
 import numpy as np
-import folium
-from folium.plugins import TimeDynamicGeoJson
-from branca.colormap import linear
+
+import pandas as pd
 
 
 def test_timedynamic_geo_json():
     """
-    tests folium.plugins.TimeDynamicGeoJson
+    tests folium.plugins.TimeSliderChoropleth
     """
     assert 'naturalearth_lowres' in gpd.datasets.available
     datapath = gpd.datasets.get_path('naturalearth_lowres')
     gdf = gpd.read_file(datapath)
 
-    n_periods = 10
+    n_periods = 3
     dt_index = pd.date_range('2016-1-1', periods=n_periods, freq='M').strftime('%s')
 
     styledata = {}
 
     for country in gdf.index:
         pdf = pd.DataFrame(
             {'color': np.random.normal(size=n_periods),
-            'opacity': np.random.normal(size=n_periods)},
+             'opacity': np.random.normal(size=n_periods)},
             index=dt_index)
         styledata[country] = pdf.cumsum()
 
@@ -51,23 +61,21 @@ def norm(col):
 
     m = folium.Map((0, 0), tiles='Stamen Watercolor', zoom_start=2)
 
-    folium.plugins.TimeDynamicGeoJson(
+    time_slider_choropleth = TimeSliderChoropleth(
         gdf.to_json(),
         styledict
-    ).add_to(m)
+    )
+    time_slider_choropleth.add_to(m)
 
-    m._repr_html_()
+    rendered = time_slider_choropleth._template.module.script(time_slider_choropleth)
 
+    m._repr_html_()
     out = m._parent.render()
+    assert '<script src="https://d3js.org/d3.v4.min.js"></script>' in out
 
-    # We verify that imports
-    assert '<script src="https://d3js.org/d3.v4.min.js' in out  # noqa
-
-    # We verify that data has been inserted currectly
-    expected_timestamps = ("var timestamps = ['1454166000', '1456671600', '1459350000', "
-                           "'1461942000', '1464620400', '1467212400', '1469890800', "
-                           "'1472569200', '1475161200', '1477839600'];")
-    #assert expected_timestamps in out
+    # We verify that data has been inserted correctly
+    expected_timestamps = """var timestamps = ["1454198400", "1456704000", "1459382400"];"""  # noqa
+    assert expected_timestamps.split(';')[0].strip() == rendered.split(';')[0].strip()
 
-    expected_styledict = json.dumps(styledict).replace('"', "'")
-    assert expected_styledict in out
+    expected_styledict = json.dumps(styledict, sort_keys=True, indent=2)
+    assert expected_styledict in rendered