Add Timeline plugin #1870

hansthen · 2024-02-04T21:54:02Z

I closed the earlier pull request for the timeline functionality as I was not happy with the approach. I think a separate plugin is better. I think the difference in functionality is sufficient to warrant its own plugin.

Besides the ability to use end time, this plugin also does not require a array of times array with matching elements in a geometry array. Just giving each feature a start and end is simpler.

Another timeline specific functionality, is that it allows multiple layers to be controlled by a single TimeLineSlider control.

Lastly, the Timeline class inherits from GeoJson, so it can use GeoJsonPopup and GeoJsonTooltip objects.

hansthen · 2024-02-05T06:20:18Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

hansthen · 2024-03-05T06:55:57Z

Btw, if you think this plugin is best served in its own repository, I am fine with that as well.

Conengmo · 2024-03-05T08:29:43Z

Sorry for the delay in reviewing, I will get to it shortly. I did the easy things first :)

hansthen · 2024-03-05T20:12:54Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

Conengmo

I'd like to have this plugin in our repo, since it seems like a better approach than our current timestamped geojson plugin. But some work is needed to get it mergeable.

I added some comments based on the code alone, I didn't test it yet because the example is missing data.

We'll also need:

an entry in our documentation
list this plugin in the 'plugins' page in the docs. We'll have to make sure that the description of this one and of timestamped geojson show the difference between the two.
importing both classes in folium/plugins/init.py

requirements.txt

folium/plugins/timeline.py

Updated the documentation for timestamped_geojson to clarify the difference with timeline. Also used a simpler code example in timeline.py docstring.

hansthen · 2024-03-07T19:41:37Z

docs/user_guide/plugins/timeline.md

The reference to the Skeate repo in line 42 is temporary, to make the tests pass. Once the PR is accepted I will change this to point to data inside our own repository.

hansthen · 2024-03-07T19:44:55Z

I added documentation and tests. I also updated the documentation of timestamped_geojson to make the reader aware of the two plugins. The tests (for now) refer to an example data file (borders.json) in the skeate repo. This is just to make the tests pass until this PR is accepted. I will update it to point to the Folium repo once the PR is accepted.

hansthen · 2024-03-23T09:36:48Z

Any chance to have a look at the updated PR?

hansthen · 2024-03-23T09:39:52Z

@Conengmo @ocefpaf I know Folium is a volunteer project and I greatly appreciate your work on it. It is hard to make time free next to work and family obligations. Thank you both for the effort you put in the project!

I feel a bit guilty for adding to your workload by spamming you with Pull Requests. Is there any way I can help that will lessen the demands placed on you?

Conengmo

Thanks for addressing my comments! Documentation looks good 👍 I think we're really close here, some minor comments and proposed steps for hosting the example data ourselves first. After that we should be able to merge this one!

docs/user_guide/plugins/timeline.md

docs/user_guide/plugins/timestamped_geojson.md

folium/plugins/timeline.py

Conengmo · 2024-04-03T10:39:39Z

I know Folium is a volunteer project and I greatly appreciate your work on it. It is hard to make time free next to work and family obligations. Thank you both for the effort you put in the project!

Thanks for your kind words, I really appreciate it 🙏

I feel a bit guilty for adding to your workload by spamming you with Pull Requests. Is there any way I can help that will lessen the demands placed on you?

Appreciate the question, but I'm happy to have high quality contributions, that's not spam! I have two thoughts. First to make PRs that are easy to review and merge. Clear description, complete, and most importantly simple and concise, so no unnecessary stuff and simple code. Second to help keep Folium maintainable in the future by being critical of the tradeoff between added complexity and new features.

If you're interested, you can also become more involved with maintaining Folium. Helping triage issues would be very useful. And also help review PRs other than your own. Are you interested in something like that?

Co-authored-by: Frank Anema <[email protected]>

hansthen · 2024-04-03T14:05:55Z

If you're interested, you can also become more involved with maintaining Folium. Helping triage issues would be very useful. And also help review PRs other than your own. Are you interested in something like that?

I can help with both. I did start with the issue list to see if there were things I could work on or reproduce. For code reviews, how would you prefer to start? Will you use the github "request code review" feature to assign PRs to me?

Conengmo · 2024-04-03T15:16:40Z

I can help with both.

That's great! I added you as a collaborator on Folium. You can now also close issues or apply labels. And you can merge PRs as well. Please use this responsibly: not merging your own code without review, and for now to start get a second opinion before merging anything consequential.

For code reviews, how would you prefer to start? Will you use the github "request code review" feature to assign PRs to me?

Yes, but you can also take initiative to review any issue or PR that has your interest and that you feel you could help with.

Conengmo · 2024-04-03T15:18:34Z

@ocefpaf @martinfleis wanted to let you know as well I invited @hansthen to become a collaborator, see https://github.com/python-visualization/folium/settings/access.

Conengmo

Looks like examples/data/borders.json is still in this PR.

Nearly there!

folium/plugins/timeline.py

Co-authored-by: Frank Anema <[email protected]>

hansthen · 2024-04-04T12:59:12Z

Looks like examples/data/borders.json is still in this PR.

Nearly there!

I used the smaller copy from the examples (also updated in the tests).

Conengmo

Great, thanks!

hansthen added 4 commits January 27, 2024 13:07

Add interval support to timestamped_geo_json

49c46e4

Try with separate timeline

0faf35e

Fix error in documentation

db4bcd5

Fixed breaking test

ba996d7

[pre-commit.ci] auto fixes from pre-commit.com hooks

79cb4ae

for more information, see https://pre-commit.ci

Conengmo self-requested a review February 19, 2024 10:56

Merge branch 'main' into leaflet_timeline_controller

bdff586

[pre-commit.ci] auto fixes from pre-commit.com hooks

26f0a89

for more information, see https://pre-commit.ci

Conengmo requested changes Mar 6, 2024

View reviewed changes

hansthen added 5 commits March 7, 2024 07:43

Based on review comments

7a96684

Add classes to namespace per review comments

78663f9

Added documentation for timeline plugin

835d45c

Updated the documentation for timestamped_geojson to clarify the difference with timeline. Also used a simpler code example in timeline.py docstring.

Add test + fix CDN import

54c82b4

Piggyback on borders.json from the Skeat timeline repo

f71c07f

hansthen commented Mar 7, 2024

View reviewed changes

hansthen requested a review from Conengmo March 7, 2024 19:45

Conengmo requested changes Apr 3, 2024

View reviewed changes

Conengmo changed the title ~~Leaflet timeline controller~~ Add Timeline plugin Apr 3, 2024

hansthen and others added 2 commits April 3, 2024 15:36

Update docs/user_guide/plugins/timestamped_geojson.md

d917fde

Co-authored-by: Frank Anema <[email protected]>

Updated after review comments

fc626dc

hansthen requested a review from Conengmo April 4, 2024 11:47

Conengmo requested changes Apr 4, 2024

View reviewed changes

folium/plugins/timeline.py Outdated Show resolved Hide resolved

hansthen and others added 2 commits April 4, 2024 14:43

Made the example file smaller

46cf423

Update folium/plugins/timeline.py

1c8e174

Co-authored-by: Frank Anema <[email protected]>

hansthen requested a review from Conengmo April 4, 2024 13:00

Conengmo approved these changes Apr 4, 2024

View reviewed changes

Conengmo merged commit 007fa8c into python-visualization:main Apr 4, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Timeline plugin #1870

Add Timeline plugin #1870

hansthen commented Feb 4, 2024

hansthen commented Feb 5, 2024

hansthen commented Mar 5, 2024

Conengmo commented Mar 5, 2024 •

edited

Loading

hansthen commented Mar 5, 2024

Conengmo left a comment

hansthen Mar 7, 2024 •

edited

Loading

hansthen commented Mar 7, 2024

hansthen commented Mar 23, 2024

hansthen commented Mar 23, 2024

Conengmo left a comment

Conengmo commented Apr 3, 2024

hansthen commented Apr 3, 2024

Conengmo commented Apr 3, 2024

Conengmo commented Apr 3, 2024

Conengmo left a comment

hansthen commented Apr 4, 2024

Conengmo left a comment

Add Timeline plugin #1870

Add Timeline plugin #1870

Conversation

hansthen commented Feb 4, 2024

hansthen commented Feb 5, 2024

hansthen commented Mar 5, 2024

Conengmo commented Mar 5, 2024 • edited Loading

hansthen commented Mar 5, 2024

Conengmo left a comment

Choose a reason for hiding this comment

hansthen Mar 7, 2024 • edited Loading

Choose a reason for hiding this comment

hansthen commented Mar 7, 2024

hansthen commented Mar 23, 2024

hansthen commented Mar 23, 2024

Conengmo left a comment

Choose a reason for hiding this comment

Conengmo commented Apr 3, 2024

hansthen commented Apr 3, 2024

Conengmo commented Apr 3, 2024

Conengmo commented Apr 3, 2024

Conengmo left a comment

Choose a reason for hiding this comment

hansthen commented Apr 4, 2024

Conengmo left a comment

Choose a reason for hiding this comment

Conengmo commented Mar 5, 2024 •

edited

Loading

hansthen Mar 7, 2024 •

edited

Loading