TimeDynamicGeoJson plugin #736

halfdanrump · 2017-09-27T08:31:35Z

This is a pull request to merge in a plugin called TimeDynamicGeoJson.

The main bulk of the code is in folium/plugins/timedynamic_geo_json.py.
The class uses d3. For now I put the script import in folium/map.py, but let me know if there's a better place to do this :).
There's a notebook demonstrating the plugin here. I think it'd be useful to merge in that notebook as well, but it's probably better left for a later pull request.

Cheers!

…171e11)

stickler-ci · 2017-09-27T08:32:09Z

folium/map.py

@@ -37,6 +41,9 @@
     'https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/1.0.0/leaflet.markercluster.js'),  # noqa
    ]

+for js in _d3_js: 


W291 trailing whitespace

stickler-ci · 2017-09-27T08:32:09Z

folium/plugins/timedynamic_geo_json.py

+import json
+from jinja2 import Template
+
+from branca.element import MacroElement, Figure, JavascriptLink, CssLink


F401 'branca.element.JavascriptLink' imported but unused
F401 'branca.element.Figure' imported but unused
F401 'branca.element.MacroElement' imported but unused
F401 'branca.element.CssLink' imported but unused

stickler-ci · 2017-09-27T08:32:10Z

folium/plugins/timedynamic_geo_json.py

+    >>> GeoJson(geojson, style_function=style_function)
+
+    """
+    def __init__(self, data, styledict, style_function=None, name=None,


C901 'TimeDynamicGeoJson.init' is too complex (13)

stickler-ci · 2017-09-27T08:32:10Z

folium/plugins/timedynamic_geo_json.py

+                 overlay=True, control=True, smooth_factor=None,
+                 highlight_function=None):
+        super(TimeDynamicGeoJson, self).__init__(name=name, overlay=overlay,
+                                      control=control)


E128 continuation line under-indented for visual indent

stickler-ci · 2017-09-27T08:32:11Z

folium/plugins/timedynamic_geo_json.py

+            raise ValueError('Unhandled object {!r}.'.format(data))
+
+
+        self.styledict = styledict


E303 too many blank lines (2)

stickler-ci · 2017-09-27T08:32:11Z

folium/plugins/timedynamic_geo_json.py

+
+
+        self.styledict = styledict
+


W293 blank line contains whitespace

stickler-ci · 2017-09-27T08:32:12Z

folium/plugins/timedynamic_geo_json.py

+
+        # make set of timestamps
+        self.timestamps = set()
+        for feature in self.styledict.values(): 


W291 trailing whitespace

stickler-ci · 2017-09-27T08:32:12Z

folium/plugins/timedynamic_geo_json.py

+
+            {% endmacro %}
+            """)  # noqa
+


W293 blank line contains whitespace

stickler-ci · 2017-09-28T05:14:48Z

folium/plugins/timedynamic_geo_json.py

+            raise ValueError('Unhandled object {!r}.'.format(data))
+
+        self.styledict = styledict
+


W293 blank line contains whitespace

stickler-ci · 2017-09-28T05:14:49Z

folium/plugins/timedynamic_geo_json.py

+
+            {% endmacro %}
+            """)  # noqa
+


W293 blank line contains whitespace

stickler-ci · 2017-09-28T06:34:59Z

folium/plugins/timedynamic_geo_json.py

+                 overlay=True, control=True, smooth_factor=None,
+                 highlight_function=None):
+        super(TimeDynamicGeoJson, self).__init__(name=name, overlay=overlay,
+                                                control=control)


E128 continuation line under-indented for visual indent

ocefpaf

There are a lot of good ideas here but you need to use the latest master to avoid conflicts and you can reduce a lot of the code by inheriting from the GeoJson class instead of Layer.

ocefpaf · 2017-09-29T20:52:46Z

folium/map.py

@@ -22,6 +22,10 @@

 ENV = Environment(loader=PackageLoader('folium', 'templates'))

+_d3_js = [
+    ('d3', 'http://d3js.org/d3.v4.min.js'),


This should be in the plugin and not in the global map.

ocefpaf · 2017-09-29T20:53:50Z

folium/plugins/timedynamic_geo_json.py

@@ -0,0 +1,257 @@
+import json
+from ..map import Layer


Please use absolute imports to keep it consistent with the rest of the code.

ocefpaf · 2017-09-29T20:54:14Z

folium/plugins/timedynamic_geo_json.py

+import json
+from ..map import Layer
+from jinja2 import Template
+from branca.utilities import none_min, none_max, iter_points


These are now in folium.utilities.

ocefpaf · 2017-09-29T20:55:30Z

folium/plugins/timedynamic_geo_json.py

+
+        self.smooth_factor = smooth_factor
+
+        self._template = Template(u"""


You can probably inherit from the GeoJson class and save a lot of the duplication by only changing the template.

@ocefpaf Good idea!

ocefpaf · 2017-09-29T20:59:27Z

This is a pull request to merge in a plugin called TimeDynamicGeoJson.

Looks cool! Thanks for the PR!!

The class uses d3. For now I put the script import in folium/map.py, but let me know if there's a better place to do this :)

See https://github.com/python-visualization/folium/blob/master/folium/plugins/draw.py#L67-L71

There's a notebook demonstrating the plugin here. I think it'd be useful to merge in that notebook as well, but it's probably better left for a later pull request.

Not really, you can add it to the examples folder in this PR. Remember to also add some tests and an entry to the changelog.

halfdanrump · 2017-10-03T11:08:30Z

@ocefpaf Thank you for reviewing the code! I'll implement the changes and push again :)

stickler-ci · 2017-10-04T03:14:46Z

folium/plugins/timedynamic_geo_json.py

+                var datestring = new Date(parseInt(current_timestamp)*1000).toDateString();
+                d3.select("output#slider-value").text(datestring);
+                fill_map();
+                }); 


W291 trailing whitespace

stickler-ci · 2017-10-04T03:14:46Z

folium/plugins/timedynamic_geo_json.py

+                    {% endif %}
+                    ).addTo({{this._parent.get_name()}}
+                );
+


W293 blank line contains whitespace

stickler-ci · 2017-10-04T03:14:46Z

folium/plugins/timedynamic_geo_json.py

+                    ).addTo({{this._parent.get_name()}}
+                );
+
+        	{{this.get_name()}}.setStyle(function(feature) {feature.properties.style;});


E101 indentation contains mixed spaces and tabs
W191 indentation contains tabs

stickler-ci · 2017-10-04T03:14:47Z

folium/plugins/timedynamic_geo_json.py

+                );
+
+        	{{this.get_name()}}.setStyle(function(feature) {feature.properties.style;});
+


W293 blank line contains whitespace

stickler-ci · 2017-10-04T03:14:47Z

folium/plugins/timedynamic_geo_json.py

+                    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);


E501 line too long (143 > 120 characters)

stickler-ci · 2017-10-04T03:14:48Z

folium/plugins/timedynamic_geo_json.py

+
+                d3.selectAll('path').attr('stroke', 'white').attr('stroke-width', 0.8).attr('stroke-dasharray', '5,5').attr('fill-opacity', 0);
+                fill_map();
+


W293 blank line contains whitespace

stickler-ci · 2017-10-04T03:14:48Z

tests/plugins/test_timedynamic_geo_json.py

+import folium
+from branca.colormap import linear
+
+def test_timedynamic_geo_json():


E302 expected 2 blank lines, found 1

stickler-ci · 2017-10-04T03:14:49Z

tests/plugins/test_timedynamic_geo_json.py

+    for country in gdf.index:
+        pdf = pd.DataFrame({'color': np.random.normal(size=n_periods),
+                            'opacity': np.random.normal(size=n_periods)},
+                            index=dt_index)


E127 continuation line over-indented for visual indent

stickler-ci · 2017-10-04T03:14:49Z

tests/plugins/test_timedynamic_geo_json.py

+        min_color = min(max_color, data['color'].min())
+
+    cmap = linear.PuRd.scale(min_color, max_color)
+    norm = lambda x: (x - x.min())/(x.max()-x.min())


E731 do not assign a lambda expression, use a def

stickler-ci · 2017-10-04T06:50:33Z

folium/plugins/timedynamic_geo_json.py

+                    ).addTo({{this._parent.get_name()}}
+                );
+
+        	{{this.get_name()}}.setStyle(function(feature) {feature.properties.style;});


E101 indentation contains mixed spaces and tabs
W191 indentation contains tabs

Mix of space and tabs are a no-no. Can you try to find the tabs and make everything spaces?

stickler-ci · 2017-10-04T06:50:34Z

tests/plugins/test_timedynamic_geo_json.py

+    for country in gdf.index:
+        pdf = pd.DataFrame(
+            {'color': np.random.normal(size=n_periods),
+            'opacity': np.random.normal(size=n_periods)},


E128 continuation line under-indented for visual indent

…build

stickler-ci · 2017-10-05T02:39:32Z

tests/plugins/test_timedynamic_geo_json.py

+    #assert expected_timestamps in out
+
+    expected_styledict = json.dumps(styledict).replace('"', "'")
+    #assert expected_styledict in out


E265 block comment should start with '# '

halfdanrump · 2017-10-05T02:51:09Z

@ocefpaf I've made the changes that you requested :). Buut:

I keep getting linter errors. I use pylint on my local machine
the test that passes locally fail on the CI. I'm trying to figure out why.

ocefpaf · 2017-10-05T10:59:00Z

I keep getting linter errors. I use pylint on my local machine

Don't worry about the lints right now. We can fix those later.

the test that passes locally fail on the CI. I'm trying to figure out why.

It seems that only Python 2.7 is failing. I'll download your code an investigate it locally.

ocefpaf · 2017-10-05T19:24:15Z

folium/plugins/timedynamic_geo_json.py

+    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.


You can probably remove all that, refer to the GeoJson docs, and add only what is different about this plugin.

ocefpaf · 2017-10-05T19:25:19Z

folium/plugins/timedynamic_geo_json.py

+                    ).addTo({{this._parent.get_name()}}
+                );
+
+        	{{this.get_name()}}.setStyle(function(feature) {feature.properties.style;});


Mix of space and tabs are a no-no. Can you try to find the tabs and make everything spaces?

ocefpaf · 2017-10-05T19:25:33Z

folium/plugins/timedynamic_geo_json.py

+        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


ocefpaf · 2017-10-05T19:26:39Z

folium/plugins/timedynamic_geo_json.py

+                fill_map();
+                });
+
+                {% if this.highlight %}


Note to self: unfortunately this repetition is needed b/c of the current design we cannot extend the jinja template.

ocefpaf · 2017-10-05T19:28:05Z

tests/plugins/test_timedynamic_geo_json.py

+    expected_timestamps = ("var timestamps = ['1454166000', '1456671600', '1459350000', "
+                           "'1461942000', '1464620400', '1467212400', '1469890800', "
+                           "'1472569200', '1475161200', '1477839600'];")
+    #assert expected_timestamps in out


Are you planning on un-commenting this part?

ocefpaf · 2017-10-05T20:55:10Z

I am preparing a PR to your fork with some changes that will help you finish this PR.
One quick question, how about we name this TimeSliderChoropleth instead of TimeDynamicGeoJson?

halfdanrump · 2017-10-06T07:30:39Z

@ocefpaf

I am preparing a PR to your fork with some changes that will help you finish this PR.

Thank you!

One quick question, how about we name this TimeSliderChoropleth instead of TimeDynamicGeoJson?

It's a better name, I agree :).

ocefpaf · 2017-10-06T18:18:37Z

I was not able to send #741 to your branch, so I created a new PR. I'll try to finish the docs tomorrow and get it merged so you can polish the details if you want.

halfdanrump · 2017-10-10T07:55:57Z

I was not able to send #741 to your branch, so I created a new PR. I'll try to finish the docs tomorrow and get it merged so you can polish the details if you want.

Alright, sounds good :))

ocefpaf · 2017-10-10T11:12:01Z

OK. I'll try to finalize this later this week. Thanks!

halfdanrump and others added 13 commits June 23, 2017 15:20

Patches map.py and feature.GeoJson to have a time slider

8e28713

moves map.py and features.py to correct directory

3b006f0

Sets mouseout opacity to 0.8

724f83a

Create TimeDynamicGeoJson class and moves slider code from map.py

4b2565e

Restores features.py to unmodified version before branching (commit 2…

99acd56

…171e11)

TimeDynamicGeoJson can now be used to create a time dynamic choropleth

0211cfe

Removes infodict

6233e23

Removes unused d3 imports

1a03f7f

Several bugfixes && adds output for dispaying current value of slider

dbe24d8

adds import of TimeDynamicGeoJson in plugins package init

57e9d11

Adds TimeDynamicGeoJson to __all__

24de854

Cleans up map.py

9987e09

Removes a few lines spaces for the purpose of intense beauty

6be6733

halfdanrump mentioned this pull request Sep 27, 2017

Choropleth with time slider #722

Closed

stickler-ci reviewed Sep 27, 2017

View reviewed changes

folium/plugins/timedynamic_geo_json.py Outdated

self.styledict = styledict

Copy link

stickler-ci Sep 27, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

W293 blank line contains whitespace

stickler-ci reviewed Sep 27, 2017

View reviewed changes

folium/plugins/timedynamic_geo_json.py Outdated

{% endmacro %}

""") # noqa

Copy link

stickler-ci Sep 27, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

W293 blank line contains whitespace

Fixes several linter warnings

491c188

stickler-ci reviewed Sep 28, 2017

View reviewed changes

folium/plugins/timedynamic_geo_json.py Outdated

{% endmacro %}

""") # noqa

Copy link

stickler-ci Sep 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

W293 blank line contains whitespace

removed empty line whitespaces

3a26638

stickler-ci reviewed Sep 28, 2017

View reviewed changes

ocefpaf reviewed Sep 29, 2017

View reviewed changes

stickler-ci reviewed Oct 4, 2017

View reviewed changes

folium/plugins/timedynamic_geo_json.py Outdated

{% endif %}

).addTo({{this._parent.get_name()}}

);

Copy link

stickler-ci Oct 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

W293 blank line contains whitespace

stickler-ci reviewed Oct 4, 2017

View reviewed changes

minor changes and pylint pleasing

854755d

stickler-ci reviewed Oct 4, 2017

View reviewed changes

Temporarily removes some assertions to verify that test passes on CI …

d1ff191

…build

stickler-ci reviewed Oct 5, 2017

View reviewed changes

Puts back in assertion of styledict

7bfabf3

python-visualization deleted a comment from stickler-ci Oct 5, 2017

ocefpaf reviewed Oct 5, 2017

View reviewed changes

ocefpaf mentioned this pull request Oct 6, 2017

Time dynamic geo json #741

Merged

ocefpaf merged commit 7bfabf3 into python-visualization:master Oct 24, 2017

		raise ValueError('Unhandled object {!r}.'.format(data))


		self.styledict = styledict


		self.smooth_factor = smooth_factor

		self._template = Template(u"""

		);

		{{this.get_name()}}.setStyle(function(feature) {feature.properties.style;});


		d3.selectAll('path').attr('stroke', 'white').attr('stroke-width', 0.8).attr('stroke-dasharray', '5,5').attr('fill-opacity', 0);
		fill_map();

TimeDynamicGeoJson plugin #736

TimeDynamicGeoJson plugin #736

Uh oh!

Conversation

halfdanrump commented Sep 27, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ocefpaf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ocefpaf commented Sep 29, 2017

Uh oh!

halfdanrump commented Oct 3, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

halfdanrump commented Oct 5, 2017

Uh oh!

ocefpaf commented Oct 5, 2017