Add a time named argument to to_png
#764
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since it might take longer than 3 seconds to render the map, this adds a time named arg that allows you to delay the screenshot.
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
| @@ -267,8 +267,19 @@ def _repr_html_(self, **kwargs): | |||
| out = self._parent._repr_html_(**kwargs) | |||
| return out | |||
|
|
|||
| def _to_png(self): | |||
| """Export the HTML to byte representation of a PNG image.""" | |||
| def _to_png(self, time=3): | |||
There was a problem hiding this comment.
F811 redefinition of unused 'time' from line 12
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
| """Export the HTML to byte representation of a PNG image.""" | ||
| def _to_png(self, time=3): | ||
| """Export the HTML to byte representation of a PNG image. | ||
|
|
There was a problem hiding this comment.
W293 blank line contains whitespace
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
| def _to_png(self, time=3): | ||
| """Export the HTML to byte representation of a PNG image. | ||
|
|
||
| Uses Phantom JS to render the HTML and record a PNG. You may need to |
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
| """Export the HTML to byte representation of a PNG image. | ||
|
|
||
| Uses Phantom JS to render the HTML and record a PNG. You may need to | ||
| adjust the time keyword argument if maps render without data or tiles. |
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
| adjust the time keyword argument if maps render without data or tiles. | ||
| Examples | ||
| -------- | ||
|
|
There was a problem hiding this comment.
W293 blank line contains whitespace
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
| -------- | ||
|
|
||
| map._to_png() | ||
|
|
There was a problem hiding this comment.
W293 blank line contains whitespace
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
|
|
||
| map._to_png() | ||
|
|
||
| map._to_png(time=10) # Wait 10 seconds between render and snapshot. |
stickler-ci
reviewed
Oct 31, 2017
folium/folium.py
Outdated
| map._to_png() | ||
|
|
||
| map._to_png(time=10) # Wait 10 seconds between render and snapshot. | ||
|
|
There was a problem hiding this comment.
W293 blank line contains whitespace
Makes perfect sense. Thanks! |
stickler-ci
reviewed
Nov 2, 2017
folium/folium.py
Outdated
| def _to_png(self, delay=3): | ||
| """Export the HTML to byte representation of a PNG image. | ||
|
|
||
| Uses Phantom JS to render the HTML and record a PNG. You may need to |
stickler-ci
reviewed
Nov 2, 2017
folium/folium.py
Outdated
| """Export the HTML to byte representation of a PNG image. | ||
|
|
||
| Uses Phantom JS to render the HTML and record a PNG. You may need to | ||
| adjust the `delay` time keyword argument if maps render without data or tiles. |
stickler-ci
reviewed
Nov 2, 2017
folium/folium.py
Outdated
| Examples | ||
| -------- | ||
| >>> map._to_png() | ||
| >>> map._to_png(time=10) # Wait 10 seconds between render and snapshot. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since it might take longer than 3 seconds to render the map, this adds a time named arg that allows you to delay the screenshot.