Custom iconCreateFunction in the constructor #701

odovad · 2017-08-31T14:20:08Z

Possible to add a custom iconCreateFunction to the constructor.

Please see the example below :

icon_create_function = """
function (cluster) {
    var childCount = cluster.getChildCount();
    var c = ' marker-cluster-small';
    return new L.DivIcon({ html: '<div><span>' + childCount + '</span></div>', className: 'marker-cluster' + c, iconSize: new L.Point(40, 40) });
}
"""

Possible to add a custom iconCreateFunction to the constructor. Please see the example below : icon_create_function = """ function (cluster) { var childCount = cluster.getChildCount(); var c = ' marker-cluster-small'; return new L.DivIcon({ html: '<div><span>' + childCount + '</span></div>', className: 'marker-cluster' + c, iconSize: new L.Point(40, 40) }); } """

stickler-ci · 2017-08-31T14:20:38Z

folium/features.py

        self._template = Template(u"""
            {% macro script(this, kwargs) %}
-            var {{this.get_name()}} = L.markerClusterGroup();
+            var {{this.get_name()}} = L.markerClusterGroup({
+                {% if this._icon_create_function != "" %}iconCreateFunction: {{this._icon_create_function}}{% else %}{% endif %}


E501 line too long (128 > 120 characters)

ocefpaf

Please add:

a test test for this functionality;
docstring exampling this option;
use example in the docstring;
a notebook example, it can be the same as the docstring (optional);
an entry in the changelog.

See https://github.com/Leaflet/Leaflet.markercluster/blob/f175a7cc31322a194ecafc28bbf4fcfe953c476e/README.md for creating docstring.

ocefpaf · 2017-08-31T14:36:28Z

folium/features.py

@@ -758,13 +758,18 @@ class MarkerCluster(Layer):
        Whether the Layer will be included in LayerControls

    """
-    def __init__(self, name=None, overlay=True, control=True):
+    def __init__(self, name=None, overlay=True, control=True, icon_create_function=""):


please change icon_create_function="" to icon_create_function='' . Sounds silly, but with all the jinja templates represent JSONs it is nice to have single quotes for python code and double for JSON. (Makes it easier to read.)

Ok, I try to do all you've said.

ocefpaf · 2017-08-31T14:38:05Z

folium/features.py

        self._template = Template(u"""
            {% macro script(this, kwargs) %}
-            var {{this.get_name()}} = L.markerClusterGroup();
+            var {{this.get_name()}} = L.markerClusterGroup({
+                {% if this._icon_create_function != "" %}


I believe that {% if this._icon_create_function %} would work.
Also, maybe a default to None instead of ''would be more readable.

Yes, you're right. It works.

ocefpaf · 2017-08-31T14:50:21Z

@odovad maybe we could take this opportunity and upgrade to 1.1.0

See https://github.com/Leaflet/Leaflet.markercluster/blob/f175a7cc31322a194ecafc28bbf4fcfe953c476e/CHANGELOG.md#110-2017-08-27

stickler-ci · 2017-08-31T15:00:13Z

folium/features.py

@@ -756,15 +756,21 @@ class MarkerCluster(Layer):
        Adds the layer as an optional overlay (True) or the base layer (False).
    control : bool, default True
        Whether the Layer will be included in LayerControls
-
+    icon_create_function : string, default None
+        Override the default behaviour, making possible to customize markers colors and sizes 


W291 trailing whitespace

stickler-ci · 2017-08-31T15:07:54Z

folium/features.py

-
+    icon_create_function : string, default None
+        Override the default behaviour, making possible to customize markers colors and sizes 
+


W293 blank line contains whitespace

stickler-ci · 2017-08-31T15:07:55Z

folium/features.py

+    ... function (cluster) {
+    ...     var childCount = cluster.getChildCount();
+    ...     var c = ' marker-cluster-small';
+    ...     return new L.DivIcon({ html: '<div><span>' + childCount + '</span></div>', 


W291 trailing whitespace

stickler-ci · 2017-08-31T15:07:55Z

folium/features.py

+    ...     var childCount = cluster.getChildCount();
+    ...     var c = ' marker-cluster-small';
+    ...     return new L.DivIcon({ html: '<div><span>' + childCount + '</span></div>', 
+                               className: 'marker-cluster' + c, 


W291 trailing whitespace

stickler-ci · 2017-08-31T15:16:02Z

folium/features.py

-
+    icon_create_function : string, default None
+        Override the default behaviour, making possible to customize markers colors and sizes
+


W293 blank line contains whitespace

ocefpaf · 2017-08-31T18:25:00Z

@odovad are you done? LGTM!

Can you make and entry in the CHANGES.txt file so we can merge this 😉

odovad · 2017-08-31T23:42:08Z

@Filipe I did not have time for the file with the test and the notebook. I try to do it as fast as I can Envoyé de mon iPhone

…

Le 31 août 2017 à 20:25, Filipe ***@***.***> a écrit : @odovad are you done? LGTM! Can you make and entry in the CHANGES.txt file so we can merge this 😉 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

ocefpaf · 2017-09-01T16:32:23Z

I try to do it as fast as I can

There is no rush 😉

@Filipe I did not have time for the file with the test and the notebook.

The notebook is optional and can he added in another PR. I'll add the changelog entry if you don't mind and get this merged.

The reason is b/c I am re-factoring a bunch of stuff and I don't want you to end up having to rebase this.

Thanks a lot for the contribution!

odovad · 2017-09-01T17:21:59Z

👍🏻 Ok I thought I had to write at least the file for the test. Envoyé de mon iPhone

…

Le 1 sept. 2017 à 18:32, Filipe ***@***.***> a écrit : Merged #701. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

ocefpaf · 2017-09-01T17:33:04Z

at least the file for the test.

That will be nice to have too 😉

Custom iconCreateFunction in the constructor

stickler-ci reviewed Aug 31, 2017

View reviewed changes

Update features.py

cffe7ab

ocefpaf reviewed Aug 31, 2017

View reviewed changes

odovad changed the title ~~Custom iconCreateFunction the constructor~~ Custom iconCreateFunction in the constructor Aug 31, 2017

Update features.py

b4b4c98

stickler-ci reviewed Aug 31, 2017

View reviewed changes

Added docstring Example

e8831ee

stickler-ci reviewed Aug 31, 2017

View reviewed changes

Update features.py

adecf3c

stickler-ci reviewed Aug 31, 2017

View reviewed changes

Update features.py

e96319e

ocefpaf merged commit 9d851f5 into python-visualization:master Sep 1, 2017

sanga pushed a commit to sanga/folium that referenced this pull request Oct 24, 2017

Merge pull request python-visualization#701 from odovad/patch-1

d246e02

Custom iconCreateFunction in the constructor


		icon_create_function : string, default None
		Override the default behaviour, making possible to customize markers colors and sizes

Custom iconCreateFunction in the constructor #701

Custom iconCreateFunction in the constructor #701

Uh oh!

Conversation

odovad commented Aug 31, 2017 • edited by ocefpaf 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!

ocefpaf left a comment • 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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ocefpaf commented Aug 31, 2017

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 Aug 31, 2017

Uh oh!

odovad commented Aug 31, 2017 via email

Uh oh!

ocefpaf commented Sep 1, 2017

Uh oh!

odovad commented Sep 1, 2017 via email

Uh oh!

ocefpaf commented Sep 1, 2017

Uh oh!

Uh oh!

odovad commented Aug 31, 2017 •

edited by ocefpaf

Loading

ocefpaf left a comment •

edited

Loading