Adding popup_attribute to the GeoJson feature #376

om-henners · 2016-02-29T10:31:54Z

I've made a change to the GeoJson feature to add a popup_attribute parameter. Including this changes the template so that attribute of the feautre is used as the popup for that feature. Based on the map I did for the #gistribe 15 minute map competition.

The popup_attribute takes an attribute name and uses the attribute as the popup value for each feature in the layer. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Update to the GeoJson and GeoPandas examples to include the popup attribute Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

BibMartin · 2016-02-29T11:01:16Z

Awesome! Thanks @om-henners .

First reactions :

I'd have liked to be able to provide Popup objects to the function. This can be done in another PR.
But it would be great if the popup_attribute arg were replaced by a popup_function (at the cost of having popup_function = lambda x: 'my_attribute') to simplify this second step.
I would prefer if the if self.popup_attribute: were replaced by {% if this.popup_attribute %} in the template, so that useser may change their mind and set popup_attibute manually after the end of the __init__ method.
Having a test would be useful.
This is really great and would answer @mattwg's question in Popups on Choropleth Map #375.

om-henners · 2016-02-29T11:50:03Z

@BibMartin Happy to put in the full popup support, and you're right - it would be better to have the attribute in a single template. Cheers for the feedback!

Update the geojson popup attribute to being a popup function which will build a _popupContent attribute on features if required. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Test on the attribute being correct and the geojson producing correctly, and test on the function creating the correct _popupContent attribue on the feature. Also update test_geo_json_str so that it includes the empty options parameters. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Allow passing the popup_function through the choropleth shortcut on the map object (assuming the dataset is GeoJson) Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Update the notebooks to include a popup function for GeoJson and GeoDataFrames Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

om-henners · 2016-03-01T11:26:56Z

@BibMartin I've made a coupe of updates to the pull request:

The popup_attribute is now a popup_function parameter - if you pass in a function it should take a GeoJson feature and return a string value that is stored in a new _popupContent parameter in the feature properties. This is calculated when you intialise the GeoJson class. If you pass a string it acts as before, and simply uses that attribute as the popup value.
I've put the {% if this.popup_attribute %} in the template as requested, so the user can update the popup_attribute at a later stage. Since it calculates the results of the function on __init__ though setting a function here won't work.
I've added tests for the geojson to test_folium.py
I've added the popup_function parameter to the choropleth method on the map object as well so it will pass straight through

I also took a look at adding the Popup object, but I'll have to have a bit more of a play with it. First though I'd like to update the TopoJson methods so it's consistent with the GeoJson and also has a popup_function available.

BibMartin · 2016-03-01T15:57:37Z

folium/features.py

+            self.popup_attribute = popup_function
+        elif isinstance(popup_function, binary_type):
+            self.popup_attribute = text_type(popup_function, 'utf8')
+


This is really great ! Thanks.

I would prefer to move this paragraph (346-358) into style_data and simply write self.popup_function = popup_function here. That way, the following code will also work:

g = GeoJson(data) g.popup_function = some_function

ocefpaf · 2016-03-03T22:31:38Z

Wow! Thanks @om-henners!!

@BibMartin Can I assign you to continue reviewing and merge?

om-henners · 2016-03-03T22:56:06Z

@ocefpaf no worries - happy to help.

@BibMartin Happy to move the function to the style method. If it's ok I'll delay to tomorrow and do it on the weekend.

BibMartin · 2016-03-04T08:15:05Z

@BibMartin Can I assign you to continue reviewing and merge?

sure you can (and you do) ; I'm looking forward to review this.

@BibMartin Happy to move the function to the style method. If it's ok I'll delay to tomorrow and do it on the weekend.

No worry, no hurry. This WE is soon enough 😉

The actual population of the `_popupContent` attribute based on popup_function is now in the style attribute. This means that the `popup_function` and `popup_attribute` can be populated after the Geojson creation. The `popup_function` is actually a feature property now to ensure that the `popup_attribute` is set correctly when the function is set after the fact. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Update the geojson examples to show the popup attribute and function can be set after the fact on geojson features. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

om-henners · 2016-03-08T10:34:17Z

I've updated so that the popup_function and popup_attribute can be set after the fact, and the popup_function is called from within the style_data method.

Fix the indent to fix the comment that fails the travis build Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

om-henners · 2016-03-15T21:29:52Z

Hi @BibMartin , any more changes you'd like on this request?

BibMartin · 2016-03-22T05:48:15Z

folium/features.py

+                    feature["properties"]["_popupContent"] = self.popup_function(feature)  # noqa
+            except TypeError:
+                pass
+


Why do you need a try ?

Since the checks on the function are outside the render operation, I was being a bit slack and letting the function fail when it wasn't a function. I'll move checks inside the loop.

BibMartin · 2016-03-22T05:52:34Z

Hi @om-henners ,

sorry for the delay ; I've been quite busy this fortnight.

I've put a few question in the code but nothing's blocking. I wait for your reactions before merging.

Thnaks again!

om-henners · 2016-04-14T11:28:38Z

Hi @BibMartin , likewise sorry for the delay - been super busy here too :) I've added replies above. Happy to make the updates to the code this weekend.

AlexArcPy · 2016-08-01T16:23:24Z

Looking forward to see this functionality merged and pushed into conda package :) I believe there is no existing functionality that would let supply a geoJSON property as a pop-up value, yet this is kind of basic thing for most web mapping operations. @om-henners, brilliant.

ocefpaf · 2016-08-01T16:36:15Z

@AlexArcPy thanks for the ping.

@om-henners not sure if I will have time, but if I do are you OK if I pick your commits and finish this PR?

AlexArcPy · 2016-08-01T19:28:31Z

@ocefpaf, just realized you are the "ocean guy". Your blog posts are such huge time savers for me, every time I find your posts, I was so glad you spend hours writing them, you are legend.

ocefpaf · 2016-08-01T19:30:10Z

@ocefpaf, just realized you are the "ocean guy". Your blog posts are such huge time savers for me, every time I find your posts, I was so glad you spend hours writing them, you are legend.

😳

But here on folium the "legend" is @BibMartin 😉

cloud05 · 2016-09-05T09:04:46Z

Good day! I would just like to know when this new feature (popup for geojson) would be implemented. So I guess I'll just leave this here to be notified whenever it is ready. Thank you for your work btw. Cheers!

MRigal · 2017-09-08T13:24:35Z

Good luck @ocefpaf ! Don't hesitate to ask for help in this refactoring. It might simply be an open PR with the planned changes as comments/pseudo-code...

pmains · 2017-09-28T18:57:53Z

What is the status of this merge?

bitofbreeze · 2017-10-06T05:02:06Z

I would very much like to know as well. Can we please approve this, fixing the conflicts that are now there of course.

ocefpaf · 2017-10-06T18:24:58Z

@CSFlorin folium is maintained by volunteers on their free time. So "piling on" an issue won't help.
If you want to try a PR I will gladly review it 😉

bitofbreeze · 2017-10-08T04:57:47Z

side note: couldn't get @halfdanrump 's method to work (map just wouldn't show at all, even when the gdf has just one row), so here's an alternative that just puts a new centered point in each polygon:

def add_points(mapobj, gdf, popup_field_list):
    # Create empty lists to contain the point coordinates and the point pop-up information
    coords, popups = [], [] 
    # Loop through each record in the GeoDataFrame
    for i, row in gdf.iterrows():
        # Append lat and long coordinates to "coords" list
        coords.append([row.geometry.y, row.geometry.x])
        # Create a string of HTML code used in the IFrame popup
        # Join together the fields in "popup_field_list" with a linebreak between them
        label = '<br>'.join([field + ': ' + str(row[field]) for field in popup_field_list])
        # Append an IFrame that uses the HTML string to the "popups" list 
        popups.append(IFrame(label, width = 300, height = 100))
    
    # Create a Folium feature group for this layer, since we will be displaying multiple layers
    pt_lyr = folium.FeatureGroup(name = 'pt_lyr')

    # Add the clustered points of crime locations and popups to this layer
    pt_lyr.add_child(MarkerCluster(locations = coords, popups = popups))

    # Add this point layer to the map object
    mapobj.add_child(pt_lyr)
    return mapobj

gdf['geometry'] = gdf.apply(lambda z: Point(z.geometry.centroid.x, z.geometry.centroid.y), axis=1)
m = add_points(m, gdf, ['cols whose info you want displayed for each polygon'])
m

Sorry, I spoke too soon. I think it wasn't working for me since props was a list, so I joined each element and it worked all of a sudden. Thank you!

bitofbreeze · 2017-10-08T10:01:20Z

Does anyone know how to group the layers together so that the popup layer is always above the polygon layer and so that they appear as one in the layercontrol? Much appreciated and sorry for the bugging on this thread

ghandic · 2017-10-18T12:03:14Z

This should be solved after GeoJsonCss has been accepted in PR #748 as it allows popups per feature in the GeoJson as well as styling.

MattGraz · 2018-01-21T05:22:00Z

I'm a bit unclear as to what the status of this is? Can someone elaborate a bit on what the holdups are (aside from the obvious conflicts)?

I'm happy to put some time into this and get this feature added to Folium. Some guidance on whether or not this pull is salvageable and/or I should start from scratch would be appreciated.

Thanks!

ghandic · 2018-01-21T09:18:01Z

This works, have you tried it? We’re just waiting to add a new version to pypi.

…

Sent from my iPhone On 21 Jan 2018, at 05:22, MattGraz <notifications@github.com<mailto:notifications@github.com>> wrote: I'm a bit unclear as to what the status of this is? Can someone elaborate a bit on what the holdups are (aside from the obvious conflicts)? I'm happy to put some time into this and get this feature added to Folium. Some guidance on whether or not this pull is salvageable and/or I should start from scratch would be appreciated. Thanks! — You are receiving this because you commented. Reply to this email directly, view it on GitHub<#376 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AWaWQX2pQ5burCyoWKGzWtq2PtDZ7sXNks5tMsl8gaJpZM4HlSKV>.

MattGraz · 2018-01-21T16:26:28Z

@ghandic: Thanks for the follow up. I did get it working! I was just unsure what the status was as far as merging. Thank you for clarifying!

ritu99 · 2018-04-21T20:34:12Z

Any updates?

nittolese · 2018-05-10T10:17:58Z

@Conengmo could you resolve the conflicts in merging the pull request?
Thank you!

ocefpaf · 2018-05-10T12:54:47Z

@Conengmo could you resolve the conflicts in merging the pull request?

We are going in a different direction with GeoJsonCss. Closing this to avoid confusion.

stickler-ci · 2018-05-10T12:55:23Z

folium/features.py

+        ----------
+        func : srting, function or None
+            The popup value for the feature
+            * If string, then an attribute to use as a popup value for the feature


E501 line too long (82 > 79 characters)

om-henners added 2 commits February 29, 2016 21:23

Add the popup_attribute to the GeoJson feature

14da52e

The popup_attribute takes an attribute name and uses the attribute as the popup value for each feature in the layer. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Update examples for the popup_attribute

0c2429c

Update to the GeoJson and GeoPandas examples to include the popup attribute Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

BibMartin mentioned this pull request Feb 29, 2016

Popups on Choropleth Map #375

Closed

om-henners added 5 commits March 1, 2016 21:57

Update popup_attribute to popup_function

3747c56

Update the geojson popup attribute to being a popup function which will build a _popupContent attribute on features if required. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Drop the popup_function into choropleth

874aefd

Allow passing the popup_function through the choropleth shortcut on the map object (assuming the dataset is GeoJson) Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Example notebooks include popup_function

54bf3dc

Update the notebooks to include a popup function for GeoJson and GeoDataFrames Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Remove the extra line causing travis to fail

828d0f1

Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

BibMartin reviewed Mar 1, 2016
View reviewed changes

ocefpaf assigned BibMartin Mar 3, 2016

om-henners added 2 commits March 8, 2016 21:28

Update geojson examples

abca6b5

Update the geojson examples to show the popup attribute and function can be set after the fact on geojson features. Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

Fix comment to fix travis

bcb72b1

Fix the indent to fix the comment that fails the travis build Signed-off-by: Henry Walshaw <henry.walshaw@gmail.com>

BibMartin reviewed Mar 22, 2016
View reviewed changes

ocefpaf force-pushed the master branch 7 times, most recently from 475a974 to 2b3b5d5 Compare September 5, 2017 17:58

ocefpaf force-pushed the master branch 2 times, most recently from a352df2 to 2a2dc9a Compare September 9, 2017 17:09

bitofbreeze approved these changes Oct 6, 2017

View reviewed changes

Conengmo added work in progress Work is in progress on a PR, check the PR to see its status and removed work in progress Work is in progress on a PR, check the PR to see its status labels Apr 22, 2018

ocefpaf closed this May 10, 2018

ocefpaf reopened this May 10, 2018

stickler-ci reviewed May 10, 2018

View reviewed changes

ocefpaf closed this May 10, 2018

Conengmo mentioned this pull request May 13, 2018

features.GeoJson Tooltip #867

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding popup_attribute to the GeoJson feature #376

Adding popup_attribute to the GeoJson feature #376

om-henners commented Feb 29, 2016

BibMartin commented Feb 29, 2016

om-henners commented Feb 29, 2016

om-henners commented Mar 1, 2016

BibMartin Mar 1, 2016

ocefpaf commented Mar 3, 2016

om-henners commented Mar 3, 2016

BibMartin commented Mar 4, 2016

om-henners commented Mar 8, 2016

om-henners commented Mar 15, 2016

BibMartin Mar 22, 2016

om-henners Apr 14, 2016

BibMartin commented Mar 22, 2016

om-henners commented Apr 14, 2016

AlexArcPy commented Aug 1, 2016

ocefpaf commented Aug 1, 2016

AlexArcPy commented Aug 1, 2016

ocefpaf commented Aug 1, 2016

cloud05 commented Sep 5, 2016

MRigal commented Sep 8, 2017

pmains commented Sep 28, 2017

bitofbreeze commented Oct 6, 2017

ocefpaf commented Oct 6, 2017

bitofbreeze commented Oct 8, 2017 •

edited

bitofbreeze commented Oct 8, 2017

ghandic commented Oct 18, 2017

MattGraz commented Jan 21, 2018

ghandic commented Jan 21, 2018 via email

MattGraz commented Jan 21, 2018

ritu99 commented Apr 21, 2018

nittolese commented May 10, 2018

ocefpaf commented May 10, 2018

stickler-ci May 10, 2018

Adding popup_attribute to the GeoJson feature #376

Adding popup_attribute to the GeoJson feature #376

Conversation

om-henners commented Feb 29, 2016

BibMartin commented Feb 29, 2016

om-henners commented Feb 29, 2016

om-henners commented Mar 1, 2016

BibMartin Mar 1, 2016

Choose a reason for hiding this comment

ocefpaf commented Mar 3, 2016

om-henners commented Mar 3, 2016

BibMartin commented Mar 4, 2016

om-henners commented Mar 8, 2016

om-henners commented Mar 15, 2016

BibMartin Mar 22, 2016

Choose a reason for hiding this comment

om-henners Apr 14, 2016

Choose a reason for hiding this comment

BibMartin commented Mar 22, 2016

om-henners commented Apr 14, 2016

AlexArcPy commented Aug 1, 2016

ocefpaf commented Aug 1, 2016

AlexArcPy commented Aug 1, 2016

ocefpaf commented Aug 1, 2016

cloud05 commented Sep 5, 2016

MRigal commented Sep 8, 2017

pmains commented Sep 28, 2017

bitofbreeze commented Oct 6, 2017

ocefpaf commented Oct 6, 2017

bitofbreeze commented Oct 8, 2017 • edited

bitofbreeze commented Oct 8, 2017

ghandic commented Oct 18, 2017

MattGraz commented Jan 21, 2018

ghandic commented Jan 21, 2018 via email

MattGraz commented Jan 21, 2018

ritu99 commented Apr 21, 2018

nittolese commented May 10, 2018

ocefpaf commented May 10, 2018

stickler-ci May 10, 2018

Choose a reason for hiding this comment

bitofbreeze commented Oct 8, 2017 •

edited