Update Map zoom_control variable to also allow string to set position #1884
Conversation
This file contains 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
Conengmo
requested changes
Mar 4, 2024
folium/folium.py
Outdated
| zoom_control : bool, default True | ||
| Display zoom controls on the map. | ||
| zoom_control : bool or position string, default True | ||
| Display zoom controls on the map, eventually specifying its position. |
There was a problem hiding this comment.
Suggested change
| Display zoom controls on the map, eventually specifying its position. | |
| Display zoom controls on the map. The default `True` places it in the top left corner. | |
| Other options are 'topleft', 'topright', 'bottomleft' or 'bottomright'. |
| # Zoom control position specified ? | ||
| if isinstance(zoom_control, str): | ||
| self.zoom_control_position = True | ||
| self.zoom_control = zoom_control |
There was a problem hiding this comment.
maybe useful to add a check here for valid values? Now if a users makes an error, they just get a grey screen. For example something like:
Suggested change
| self.zoom_control = zoom_control | |
| self.zoom_control = zoom_control | |
| if zoom_control not in {'topleft', 'topright', 'bottomleft', 'bottomright'}: | |
| raise ValueError("Incorrect value for `zoom_control`, choose from 'topleft', 'topright', 'bottomleft' or 'bottomright'.") |
There was a problem hiding this comment.
I had considered introducing a check on valid position values but looking at various plugins I could not find such a check so I thought it was considered as unnecessary ...
There was a problem hiding this comment.
I understand, this code base grew quite organically over time, so it's not always consistent. Thanks for putting it in!
Conengmo
changed the title
|
Somethings going on with the tests, it's probably not related to this PR. |
Conengmo
approved these changes
Mar 5, 2024
|
Thanks for your contribution @berrfred! |
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.
This is referred to issue #1865