Tooltip classes (simple and geojson/topojson) #883

jtbaker · 2018-06-15T00:50:03Z

Added a new Tooltip class to reference GeoJson feature properties, with tests, documentation, and examples. It's flexible, and can take field names, aliases, that can be turned on/off with the 'labels' boolean, a 'sticky' property, and can incorporate Javascript's .toLocaleString() functionality if desired. The same string can be passed for each object with the 'text' variable as well if you'd rather not use the 'fields'.

Also updated the GeoJson JS template to reference this Tooltip object, and added a test to make sure that the values passed exist in the properties.

Use case at this nbviewer

Added a new Tooltip class to reference GeoJson feature properties, with tests, documentation, and examples. It's flexible, and can take field names, aliases, that can be turned on/off with the 'labels' boolean, a 'sticky' property, and can incorporate Javascript's .toLocaleString() functionality if desired. The same string can be passed for each object with the 'text' variable as well if you'd rather not use the 'fields'. Also updated the GeoJson JS template to reference this Tooltip object, and added a test to make sure that the values passed exist in the properties.

stickler-ci · 2018-06-15T00:50:25Z

folium/features.py

@@ -416,7 +431,14 @@ def __init__(self, data, style_function=None, name=None,
        self.highlight = highlight_function is not None

        self.highlight_function = highlight_function or (lambda x: {})
+


W293 blank line contains whitespace

stickler-ci · 2018-06-15T00:50:26Z

folium/features.py

+        if self.tooltip:
+            if self.tooltip.fields:
+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()), f"The value {value} is not in the available properties. For your review, they are {tuple(self.data['features'][0]['properties'].keys())}"


E501 line too long (227 > 120 characters)
E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-15T00:50:26Z

folium/features.py

+

W293 blank line contains whitespace

stickler-ci · 2018-06-15T00:50:26Z

folium/features.py

@@ -652,6 +674,63 @@ def __init__(self, html=None, icon_size=None, icon_anchor=None,
        self.className = class_name


+class Tooltip:
+    """
+Creates a Tooltip object for adding to features to display text as a property a Map by executing a javascript function when hovering the cursor over each feature.


E501 line too long (162 > 120 characters)

stickler-ci · 2018-06-15T00:50:26Z

folium/features.py

+----------
+    fields: list or tuple.
+        list or tuple of labels of the GeoJson 'properties' or GeoPandas GeodataFrame columns you'd like to display.
+    aliases: list or tuple 


W291 trailing whitespace

stickler-ci · 2018-06-15T00:50:27Z

folium/features.py

+        assert not all((fields,text)), "Please choose either fields or text."
+        assert any((fields,text)), "Please choose either fields or text."
+        assert isinstance(toLocaleString,bool), "toLocaleString must be either True or False"
+        self.fields=fields


E225 missing whitespace around operator

stickler-ci · 2018-06-15T00:50:28Z

folium/features.py

+        self.fields=fields
+        self.aliases = aliases
+        self.text = text
+        self.labels=labels


E225 missing whitespace around operator

stickler-ci · 2018-06-15T00:50:28Z

folium/features.py

+        self.aliases = aliases
+        self.text = text
+        self.labels=labels
+        self.sticky=sticky


E225 missing whitespace around operator

stickler-ci · 2018-06-15T00:50:28Z

folium/features.py

+        self.text = text
+        self.labels=labels
+        self.sticky=sticky
+        self.toLocaleString=toLocaleString


E225 missing whitespace around operator

stickler-ci · 2018-06-15T00:50:28Z

folium/features.py

+            self.result = self.fields
+        else:
+            self.result = self.text
+


W293 blank line contains whitespace

ocefpaf · 2018-06-15T10:44:24Z

@jtbaker god start! Can you please add a test and, if possible, a notebook example?

PS: it seems you have some linter issue there.

stickler-ci · 2018-06-15T16:33:33Z

folium/features.py

+        if self.tooltip:
+            if self.tooltip.fields:
+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()),


E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-15T16:33:33Z

folium/features.py

+            if self.tooltip.fields:
+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()),
+                    (f"The value {value} is not in the available properties."+


E225 missing whitespace around operator

stickler-ci · 2018-06-15T16:33:33Z

folium/features.py

+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()),
+                    (f"The value {value} is not in the available properties."+
+                    f"For your review, they are {tuple(self.data['features'][0]['properties'].keys())}")


E128 continuation line under-indented for visual indent

stickler-ci · 2018-06-15T16:33:33Z

folium/features.py

@@ -651,6 +674,69 @@ def __init__(self, html=None, icon_size=None, icon_anchor=None,
        self.html = html
        self.className = class_name

+class Tooltip:


E302 expected 2 blank lines, found 1

stickler-ci · 2018-06-15T16:33:33Z

folium/features.py

+    fields: list or tuple.
+        list or tuple of labels of the GeoJson 'properties' or GeoPandas GeodataFrame columns you'd like to display.
+    aliases: list or tuple
+        list or tuple of optional 'aliases' you'd like to display the each field name as, to describe the data in 


W291 trailing whitespace

stickler-ci · 2018-06-15T16:33:33Z

folium/features.py

+        if fields:
+            assert isinstance(fields, (list, tuple)), "Please pass a list or tuple to Fields."
+        if bool(fields) & bool(aliases):
+            assert isinstance(aliases, (list,tuple))


E231 missing whitespace after ','

stickler-ci · 2018-06-15T16:33:34Z

folium/features.py

+            assert isinstance(fields, (list, tuple)), "Please pass a list or tuple to Fields."
+        if bool(fields) & bool(aliases):
+            assert isinstance(aliases, (list,tuple))
+            assert len(fields)==len(aliases), "Fields and Aliases must have the same length."


E225 missing whitespace around operator

Further linting.

stickler-ci · 2018-06-15T16:40:01Z

folium/features.py

+        if self.tooltip:
+            if self.tooltip.fields:
+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()),(


E231 missing whitespace after ','

stickler-ci · 2018-06-15T16:40:01Z

folium/features.py

+            if self.tooltip.fields:
+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()),(
+                        f"The value {value} is not in the available properties.\n"+


E999 SyntaxError: invalid syntax
E225 missing whitespace around operator

stickler-ci · 2018-06-15T16:40:01Z

folium/features.py

+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()),(
+                        f"The value {value} is not in the available properties.\n"+
+                    	f"For your review, they are {tuple(self.data['features'][0]['properties'].keys())}"


E101 indentation contains mixed spaces and tabs
W191 indentation contains tabs

stickler-ci · 2018-06-15T16:40:01Z

folium/features.py

+                    assert value in tuple(self.data['features'][0]['properties'].keys()),(
+                        f"The value {value} is not in the available properties.\n"+
+                    	f"For your review, they are {tuple(self.data['features'][0]['properties'].keys())}"
+					)


E101 indentation contains mixed spaces and tabs
W191 indentation contains tabs

stickler-ci · 2018-06-15T16:42:53Z

folium/features.py

+            if self.tooltip.fields:
+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()), (
+                        f"The value {value} is not in the available properties.\n" + 


E999 SyntaxError: invalid syntax
W291 trailing whitespace

stickler-ci · 2018-06-15T16:42:53Z

folium/features.py

+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()), (
+                        f"The value {value} is not in the available properties.\n" + 
+                    	f"For your review, they are {tuple(self.data['features'][0]['properties'].keys())}"


E101 indentation contains mixed spaces and tabs
W191 indentation contains tabs

stickler-ci · 2018-06-15T16:50:34Z

folium/features.py

+        if self.tooltip:
+            if self.tooltip.fields:
+                for value in self.tooltip.fields:
+                    assert value in tuple(self.data['features'][0]['properties'].keys()), f"The value {value} is not in the available properties.\nFor your review, they are {tuple(self.data['features'][0]['properties'].keys())}"


E501 line too long (228 > 120 characters)
E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-15T16:52:08Z

folium/features.py

@@ -651,6 +672,70 @@ def __init__(self, html=None, icon_size=None, icon_anchor=None,
        self.html = html
        self.className = class_name

+


W293 blank line contains whitespace

stickler-ci · 2018-06-16T03:25:01Z

folium/features.py

+            if self.tooltip.fields:
+                keys = tuple(self.data['features'][0]['properties'].keys())
+                for value in self.tooltip.fields:
+                    assert value in keys, f"The value {value} is not in the available properties.\nFor your review, they are {keys}"


E501 line too long (132 > 120 characters)
E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-16T03:27:21Z

folium/features.py

+            if self.tooltip.fields:
+                keys = tuple(self.data['features'][0]['properties'].keys())
+                for value in self.tooltip.fields:
+                    assert value in keys, f"The value {value} is not available.\nFor your review, they are {keys}"


E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-16T03:29:27Z

folium/features.py

+            if self.tooltip.fields:
+                keys = tuple(self.data['features'][0]['properties'].keys())
+                for value in self.tooltip.fields:
+                    assert value in keys, f"The value {value} is not available. For your review, they are {keys}"


E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-16T03:33:24Z

folium/features.py

+            if self.tooltip.fields:
+                keys = tuple(self.data['features'][0]['properties'].keys())
+                for value in self.tooltip.fields:
+                    assert value in keys, f"{value} is not available. For your review, they are {keys}"


E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-16T03:37:28Z

folium/features.py

+            if self.tooltip.fields:
+                keys = tuple(self.data['features'][0]['properties'].keys())
+                for value in self.tooltip.fields:
+                    assert value in keys, f"{value} is not available." +


E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-16T03:42:54Z

folium/features.py

+            if self.tooltip.fields:
+                keys = tuple(self.data['features'][0]['properties'].keys())
+                for value in self.tooltip.fields:
+                    assert value in keys, (f"{value} is not available. " +


E999 SyntaxError: invalid syntax

stickler-ci · 2018-06-16T03:48:44Z

folium/features.py

+            if self.tooltip.fields:
+                keys = tuple(self.data['features'][0]['properties'].keys())
+                for value in self.tooltip.fields:
+                    assert value in keys, (f"{value} is not available in {keys}")


E999 SyntaxError: invalid syntax

Swap text to self for Tooltip -> GeoJsonTooltip inheritance.

geojson `properties`, using `JSON.stringify`. Will allow display of underlying data instead of `object Object`. Are we cool with >= ES6 syntax? It's easier to write.

Conengmo · 2018-08-03T06:08:59Z

folium/map.py

@@ -186,21 +187,29 @@ class Icon(MacroElement):
                    iconColor: '{{this.icon_color}}',
                    markerColor: '{{this.color}}',
                    prefix: '{{this.prefix}}',
-                    extraClasses: 'fa-rotate-{{this.angle}}'
+                    extraClasses: 'fa-rotate-{{this.angle}}',


You're adding an option to Icon, which is fine in itself but please do this in a separate PR.

Conengmo · 2018-08-03T06:09:28Z

folium/map.py

        super(Icon, self).__init__()
-        self._name = 'Icon'
+        self._name = 'AwesomeMarkers.icon'


Changing the name could have unintended consequences so please do this in a separate PR so it doesn't go unnoticed.

Conengmo · 2018-08-03T06:10:05Z

folium/map.py

        self.color = color
        self.icon = icon
        self.icon_color = icon_color
        self.angle = angle
        self.prefix = prefix
+        self.spin = spin
+        self.options = {'icon': icon,


Changing the way options work here doesn't belong in this PR.

Conengmo · 2018-08-03T06:12:07Z

folium/map.py


-    def __init__(self, location, popup=None, tooltip=None, icon=None):
+    def __init__(self, location=None, popup=None, tooltip=None, icon=None):


Changing the default of location here doesn't have to do with tooltip, please remove it here.

Conengmo · 2018-08-03T06:12:45Z

folium/map.py

-        self.tooltip = tooltip
-        self.location = _validate_coordinates(location)
+        self._name = 'marker'
+        if location:


This check fails with Numpy arrays. Also adding it doesn't belong in this PR.

Reverted changes to Marker that were outside scope.

stickler-ci · 2018-08-03T14:01:20Z

tests/test_utilities.py

@@ -0,0 +1,12 @@
+from __future__ import (absolute_import, division, print_function)
+
+import pytest


F401 'pytest' imported but unused

Conengmo · 2018-08-07T08:12:04Z

I removed the stowaway xml files, @jtbaker maybe add them to your .gitignore file so you don't accidentally commit them again?

I think we're good to go!

jtbaker · 2018-08-07T16:40:16Z

@Conengmo Awesome! Thanks for your help on this. This is my first real open source contribution, and I learned quite a bit in the process - have a decent grasp on JS and lower level Python, project best practices and scoping now. Looking forward to future PRs (with less errors). :-)

Since the changes have been approved, and I created this PR, am I good to close it out now? Is the merge onto the master complete, or does it need another review from @ocefpaf or someone else?

ocefpaf · 2018-08-07T16:46:32Z

@ocefpaf or someone else?

LGTM but I'll leave to @Conengmo to do the honors and merge it.

This is my first real open source contribution

Awesome! And this is not an easy one!! Thanks for all the effort and for hanging in there while we reviewed it.

Thanks for the PR! Hope to see more 😉

Conengmo · 2018-08-08T06:33:35Z

Merged! Congrats @jtbaker and glad to hear you learned stuff. It took some time to figure out how to get this right, so I appreciate your patience on this PR.

Future PRs sounds good, let's do it!

baskoes · 2018-08-10T07:09:25Z

@jtbaker thank you for your efforts. I would really appreciate an example that combines chloropleth and tooltip into one map from the same dataframe / geojson. The example in the GeoJsonTooltip class docstring just seems to call "Tooltip(" and I can't figure out where that class/function is coming from. If someone could point me in the right direction I would be happy to share a ipynb for the examples directory. thanks again.

jtbaker · 2018-08-10T13:29:47Z

@Conengmo Looks like we forgot to update the naming in the docstring after the class split. Whoops!

@baskoes, Thank you! It was fun, and I learned quite a bit about how the library works under the hood. Those references to Tooltip in the GeoJsonTooltip docstring should be to GeoJsonTooltip itself(we'll get these updated ASAP). Tooltip is a separate class for passing text of your choice, through the text argument - i.e. 'Click for more info'. GeoJsonTooltip allows you to reference the column names/properties keys, to display the associated values of each feature in the GeoJson dataset via the fields argument, with an option to relabel/describe the data in the visualization. This is completed on the fly for each feature using a JavaScript function.

I'll get a new notebook added to the examples directory to do a demo on how to use both classes.

The usage would looks something like this:

folium.GeoJson(gdf, tooltip=folium.GeoJsonTooltip(fields=['NAMELSAD',"POP2010"], aliases=['State Name','2010 Census Population'], sticky=True, style="font-family: courier new; color: steelblue;", opacity=0.8, direction='top'), )

Conengmo · 2018-08-12T18:31:24Z

Looks like we forgot to update the naming in the docstring after the class split.

Good catch, didn't notice that.

A notebook with examples of GeoJsonTooltip would be great, looking forward to reviewing and merging it. We can change the docstring in the same PR I suppose.

stickler-ci reviewed Jun 15, 2018

View reviewed changes

jtbaker changed the title ~~Update features.py~~ Update Features to add more flexible Tooltip options with GeoJson. Jun 15, 2018

jtbaker mentioned this pull request Jun 15, 2018

features.GeoJson Tooltip #867

Closed

Cleaned up code linting for this commit.

2491e19

stickler-ci reviewed Jun 15, 2018

View reviewed changes

Update features.py

6290a5b

Further linting.

stickler-ci reviewed Jun 15, 2018

View reviewed changes

Further linting.

fda9729

stickler-ci reviewed Jun 15, 2018

View reviewed changes

Hopefully last linting.

bde7a2b

stickler-ci reviewed Jun 15, 2018

View reviewed changes

Update features.py

b5f9282

stickler-ci reviewed Jun 15, 2018

View reviewed changes

jtbaker added 2 commits June 15, 2018 22:21

Update features.py

8e5168c

Update features.py

73b1f4d

stickler-ci reviewed Jun 16, 2018

View reviewed changes

lint

d03bf2f

stickler-ci reviewed Jun 16, 2018

View reviewed changes

lint

8ce80a6

stickler-ci reviewed Jun 16, 2018

View reviewed changes

lint

bb325f4

stickler-ci reviewed Jun 16, 2018

View reviewed changes

lint

bd2a12f

stickler-ci reviewed Jun 16, 2018

View reviewed changes

lint

c73686e

stickler-ci reviewed Jun 16, 2018

View reviewed changes

lint

5b9cb8b

stickler-ci reviewed Jun 16, 2018

View reviewed changes

jtbaker added 7 commits August 2, 2018 12:43

Add function to handle non-primitives in GeoJSON fields.

8b06fde

Swap text to self for Tooltip -> GeoJsonTooltip inheritance.

Switch toLocaleString to localize.

036f191

Add Function to handle non-primitives in GeoJSON fields.

c5a43bd

Switch toLocaleString to localize, along with all references.

efbd8a4

Convert template to reference this.options.

a93a4cb

create JS function to handle representation of non-primitive data in

78021f5

geojson `properties`, using `JSON.stringify`. Will allow display of underlying data instead of `object Object`. Are we cool with >= ES6 syntax? It's easier to write.

Merge branch 'patch-2' into tooltip-split

02621f9

Conengmo requested changes Aug 3, 2018

View reviewed changes

jtbaker added 3 commits August 3, 2018 08:56

Reverted changes to Marker that were out of the scope of this PR.

c8d2c7b

Merge remote-tracking branch 'origin/tooltip-split' into tooltip-split

3edd6b5

Merge pull request #23 from jtbaker/tooltip-split

cbe4622

Reverted changes to Marker that were outside scope.

stickler-ci reviewed Aug 3, 2018

View reviewed changes

Conengmo added 2 commits August 7, 2018 07:55

Remove stowaway xmls

e72f858

Linter: remove unused pytest import

285d79a

Conengmo approved these changes Aug 7, 2018

View reviewed changes

Conengmo added 5 commits August 7, 2018 08:06

Rename function to parse_options

678e459

Correct GeoJsonTooltip._name

ba10631

Typos and clarifications

c928625

Change Leaflet URL for doc build

738992c

Revert Leaflet docs urls to include version

3f3c8bf

Conengmo changed the title ~~Update Features to add more flexible Tooltip options with GeoJson.~~ Tooltip classes (simple and geojson/topojson) Aug 7, 2018

Update CHANGES.txt

ba78359

Conengmo merged commit 05f8e81 into python-visualization:master Aug 8, 2018

		@@ -416,7 +431,14 @@ def __init__(self, data, style_function=None, name=None,
		self.highlight = highlight_function is not None

		self.highlight_function = highlight_function or (lambda x: {})

		@@ -651,6 +672,70 @@ def __init__(self, html=None, icon_size=None, icon_anchor=None,
		self.html = html
		self.className = class_name


		def __init__(self, location, popup=None, tooltip=None, icon=None):
		def __init__(self, location=None, popup=None, tooltip=None, icon=None):

		@@ -0,0 +1,12 @@
		from __future__ import (absolute_import, division, print_function)

		import pytest

Tooltip classes (simple and geojson/topojson) #883

Tooltip classes (simple and geojson/topojson) #883

Uh oh!

Conversation

jtbaker commented Jun 15, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ocefpaf commented Jun 15, 2018

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!

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!

Conengmo Aug 3, 2018 • 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

jtbaker commented Jun 15, 2018 •

edited

Loading

Conengmo Aug 3, 2018 •

edited

Loading

baskoes commented Aug 10, 2018 •

edited

Loading

jtbaker commented Aug 10, 2018 •

edited

Loading