Add duration to timestamped geo json #894

andy23512 · 2018-06-23T15:59:56Z

Add duration option from L.timeDimension.layer.geoJson ( https://github.com/socib/Leaflet.TimeDimension/tree/520cb80f645112e242c5160cb44b7d5f2cae380d#options-3 ), in order to control the shown duration of feature.

Is there anything else I need to do?

Conengmo

Seems like a straight forward addition! I haven't tested it, but it looks good. I have two comments, hope you can look at them.

If you have the time, you could add an example in the relevant Notebook.

One more thing is that the test_timestamped_geo_json test is now failing. Can you take a look at it? You probably have to add your edit in there.

Conengmo · 2018-06-23T18:25:01Z

folium/plugins/timestamped_geo_json.py

@@ -41,6 +41,10 @@ class TimestampedGeoJson(MacroElement):
        Used to construct the array of available times starting
        from the first available time. Format: ISO8601 Duration
        ex: 'P1M' -> 1/month, 'P1D' -> 1/day, 'PT1H' -> 1/hour, and'PT1M' -> 1/minute
+    duration: str, default None
+        Period of time which the features will be shown on the map after their time
+        has passed. If null, all previous times will be shown. Format: ISO8601 Duration


null -> None

Conengmo · 2018-06-23T18:28:43Z

folium/plugins/timestamped_geo_json.py

@@ -110,14 +114,14 @@ class TimestampedGeoJson(MacroElement):
                })

            var {{this.get_name()}} = L.timeDimension.layer.geoJson(geoJsonLayer,
-                {updateTimeDimension: true,addlastPoint: {{'true' if this.add_last_point else 'false'}}}
+                {updateTimeDimension: true,addlastPoint: {{'true' if this.add_last_point else 'false'}},duration: {{"\""+this.duration+"\"" if this.duration else 'undefined'}}}


Can you move the if-statement to the Python code? Where self.duration is set. Makes it easier to read IMO. That way here you can just include it like duration: "{{ this.duration }}"}

Conengmo · 2018-06-23T18:30:58Z

folium/plugins/timestamped_geo_json.py

@@ -133,6 +137,7 @@ def __init__(self, data, transition_time=200, loop=True, auto_play=True, add_las
        self.add_last_point = bool(add_last_point)
        self.period = period
        self.date_options = date_options
+        self.duration = duration


Then this could be self.duration = duration if duration is not None else 'undefined'

…plate to python code

andy23512 · 2018-06-24T01:39:54Z

Thanks for the suggestions. The code, doc and test suite has been updated, and duration option has been added to existing example.

stickler-ci · 2018-06-24T10:37:56Z

folium/plugins/timestamped_geo_json.py

-    * it contains only features of types LineString, MultiPoint, MultiLineString and MultiPolygon.
-    * each feature has a 'times' property with the same length as the coordinates array.
-    * each element of each 'times' property is a timestamp in ms since epoch, or in ISO string.
+    * it contains only features of types LineString, MultiPoint, MultiLineString 


W291 trailing whitespace

stickler-ci · 2018-06-24T10:37:56Z

folium/plugins/timestamped_geo_json.py

-    * each element of each 'times' property is a timestamp in ms since epoch, or in ISO string.
+    * it contains only features of types LineString, MultiPoint, MultiLineString 
+      and MultiPolygon.
+    * each feature has a 'times' property with the same length as the 


W291 trailing whitespace

stickler-ci · 2018-06-24T10:37:56Z

folium/plugins/timestamped_geo_json.py

+      and MultiPolygon.
+    * each feature has a 'times' property with the same length as the 
+      coordinates array.
+    * each element of each 'times' property is a timestamp in ms since epoch, 


W291 trailing whitespace

stickler-ci · 2018-06-24T10:37:56Z

folium/plugins/timestamped_geo_json.py


-    Eventually, you may have Point features with a 'times' property being an array of length 1.
+    Eventually, you may have Point features with a 'times' property being an 


W291 trailing whitespace

stickler-ci · 2018-06-24T10:37:56Z

folium/plugins/timestamped_geo_json.py


    Parameters
    ----------
    data: file, dict or str.
        The timestamped geo-json 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 file, then data will be read in the file and fully embedded in 


W291 trailing whitespace

stickler-ci · 2018-06-24T10:37:56Z

folium/plugins/timestamped_geo_json.py

-        * If dict, then data will be converted to json and embedded in the javascript.
+        * 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 


W291 trailing whitespace

stickler-ci · 2018-06-24T10:37:56Z

folium/plugins/timestamped_geo_json.py

-        ex: 'P1M' -> 1/month, 'P1D' -> 1/day, 'PT1H' -> 1/hour, and'PT1M' -> 1/minute
+        ex: 'P1M' 1/month, 'P1D' 1/day, 'PT1H' 1/hour, and 'PT1M' 1/minute
+    duration: str, default None
+        Period of time which the features will be shown on the map after their 


W291 trailing whitespace

stickler-ci · 2018-06-24T10:37:57Z

folium/plugins/timestamped_geo_json.py

+        ex: 'P1M' 1/month, 'P1D' 1/day, 'PT1H' 1/hour, and 'PT1M' 1/minute
+    duration: str, default None
+        Period of time which the features will be shown on the map after their 
+        time has passed. If None, all previous times will be shown. 


W291 trailing whitespace

Conengmo · 2018-06-24T11:02:02Z

Merged. Thanks for your contribution @andy23512!

kncrane · 2018-07-09T16:16:21Z

Hello, I am getting the error message "TypeError: init() got an unexpected keyword argument 'duration' " when using the duration parameter. Are you able to help with this? I want the markers to only show for the associated timestamp but, at the minute, new markers are just getting added on top of old markers. Kirsten

Conengmo · 2018-07-10T19:04:29Z

Hi @KirstenCrane8005, are you sure you got a recent version? Your error message suggests you don't have a recent version with this PR merged in it. You can check your current version with print(folium.__version__). You should install folium from the git master branch.

kncrane · 2018-07-10T19:23:35Z

Hi, I spoke to @andy23512 and he helped me install the most recent development version. I had used pip to install so only had the latest released version 0.5.0. Thanks for your response! If anyone knows whether it is possible to pass a folium marker or folium icon such as BeautifyIcon to the 'icon' parameter under 'properties' when you're creating the geoJSON feature objects that would be a big help. I just get the error message folium marker not JSON serializable. Aim is to display a number on each marker, pulled from my pandas dataframe.

andy23512 added 2 commits June 23, 2018 23:49

add duration option to TimestampedGeoJson

2c6811a

remove additional indent

1183771

Conengmo reviewed Jun 23, 2018

View reviewed changes

andy23512 added 3 commits June 24, 2018 08:47

change doc of duration option, move if statement of duration from tem…

e33ae44

…plate to python code

update test suite to include duration option

b1e30db

add duration option to TimestampedGeoJson example

3420620

Split out lines to reduce line width

944647a

stickler-ci reviewed Jun 24, 2018

View reviewed changes

Conengmo added 2 commits June 24, 2018 12:40

Removed trailing white spaces

7d5cbc9

Entry in changelog

d66b91d

Conengmo merged commit b65e002 into python-visualization:master Jun 24, 2018

andy23512 deleted the add_duration_to_timestamped_geo_json branch July 19, 2018 03:16

p3zo mentioned this pull request Aug 13, 2018

TimestampedGeoJson duration parameter causes polygons to disappear #934

Closed


		Eventually, you may have Point features with a 'times' property being an array of length 1.
		Eventually, you may have Point features with a 'times' property being an

Add duration to timestamped geo json #894

Add duration to timestamped geo json #894

Uh oh!

Conversation

andy23512 commented Jun 23, 2018

Uh oh!

Conengmo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

andy23512 commented Jun 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

Conengmo commented Jun 24, 2018

Uh oh!

kncrane commented Jul 9, 2018

Uh oh!

Conengmo commented Jul 10, 2018

Uh oh!

kncrane commented Jul 10, 2018

Uh oh!

Uh oh!

Conengmo left a comment •

edited

Loading

andy23512 commented Jun 24, 2018 •

edited

Loading