Added options for MarkerCluster and FastMarkerCluster #837
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
stickler-ci
reviewed
Mar 24, 2018
| @@ -1,6 +1,7 @@ | |||
| # -*- coding: utf-8 -*- | |||
|
|
|||
| from __future__ import (absolute_import, division, print_function) | |||
| import json | |||
# Conflicts: # folium/plugins/fast_marker_cluster.py
stickler-ci
reviewed
Jun 23, 2018
| @@ -37,6 +37,9 @@ class FastMarkerCluster(MarkerCluster): | |||
| Whether the Layer will be included in LayerControls. | |||
| show: bool, default True | |||
| Whether the layer will be shown on opening (only for overlays). | |||
| options : dict, default None | |||
| A dictionary with options for Leaflet.markercluster. See | |||
folium/plugins/marker_cluster.py
Outdated
| icons: list of length n. | ||
| Icon for each marker. | ||
| options : dict, default None | ||
| A dictionary with options for Leaflet.markercluster. See |
|
If there are no comments I'll merge this tomorrow. |
ocefpaf
reviewed
Jun 23, 2018
| Popup for each marker. | ||
| icons: list of length n. | ||
| Icon for each marker. | ||
| options : dict, default None |
There was a problem hiding this comment.
We should look into a docstring template functionality to avoid these repetitions.
I believe pandas has a nice example of that, I'll look into it.
There was a problem hiding this comment.
Good idea. I don't know how to do that yet, but I'm interested to know.
Let's try to avoid self-merges. You can assign me to review whenever you want. |
Alright will do! Thanks for the merge. |
Thanks for the PR! |
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.
I added a way to provide the marker clusters with options. It's quite straight forward. Any options will work, I specifically needed it for
disableClusteringAtZoom.The markerClusterGroup declaration in Javascript accepts an object with key/value pairs with options. I made the (Python) MarkerCluster and FastMarkerCluster to accept an
optionsdictionary that gets json.dumped and given to the (Javascript) markerClusterGroup as argument.Since I was there, I also included the
icon_create_functionargument, since it belongs in options. I didn't include any checks on validity of the options, so that's on the user.