Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add event handlers to the Draw plugin #2000

Merged
merged 3 commits into from
Oct 18, 2024
Merged

Add event handlers to the Draw plugin #2000

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c787898
Add event handlers to the draw plugin
hansthen Oct 5, 2024
0c7f152
Removed numpy version fix
hansthen Oct 17, 2024
c7c9719
Merge branch 'main' into add_event_handlers_to_drawn_layers_in_draw_p…
hansthen Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions folium/plugins/draw.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


class Draw(JSCSSMixin, MacroElement):
"""
'''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure Black uses double quotes? Why include this change?

Vector drawing and editing plugin for Leaflet.

Parameters
Expand All @@ -28,22 +28,35 @@ class Draw(JSCSSMixin, MacroElement):
edit_options : dict, optional
The options used to configure the edit toolbar. See
https://leaflet.github.io/Leaflet.draw/docs/leaflet-draw-latest.html#editpolyoptions
on : dict, optional
Event handlers to attach to the created layer. Pass a mapping from the
names of the events to their `JsCode` handlers.

Examples
--------
>>> m = folium.Map()
>>> Draw(
... export=True,
... filename="my_data.geojson",
... show_geometry_on_click=False,
... position="topleft",
... draw_options={"polyline": {"allowIntersection": False}},
... edit_options={"poly": {"allowIntersection": False}},
... on={
... "click": JsCode(
... """
... function(event) {
... alert(JSON.stringify(this.toGeoJSON()));
... }
... """
... )
... },
... ).add_to(m)

For more info please check
https://leaflet.github.io/Leaflet.draw/docs/leaflet-draw-latest.html

"""
'''

_template = Template(
"""
Expand Down Expand Up @@ -78,11 +91,19 @@ class Draw(JSCSSMixin, MacroElement):
console.log(coords);
});
{%- endif %}

{%- for event, handler in this.on.items() %}
layer.on(
"{{event}}",
{{handler}}
);
{%- endfor %}
drawnItems_{{ this.get_name() }}.addLayer(layer);
});
{{ this._parent.get_name() }}.on('draw:created', function(e) {
drawnItems_{{ this.get_name() }}.addLayer(e.layer);
});

{% if this.export %}
document.getElementById('export').onclick = function(e) {
var data = drawnItems_{{ this.get_name() }}.toGeoJSON();
Expand Down Expand Up @@ -122,6 +143,7 @@ def __init__(
show_geometry_on_click=True,
draw_options=None,
edit_options=None,
on=None,
):
super().__init__()
self._name = "DrawControl"
Expand All @@ -132,6 +154,7 @@ def __init__(
self.show_geometry_on_click = show_geometry_on_click
self.draw_options = draw_options or {}
self.edit_options = edit_options or {}
self.on = on or {}

def render(self, **kwargs):
super().render(**kwargs)
Expand Down
Loading