diff --git a/docs/user_guide/plugins/grouped_layer_control.md b/docs/user_guide/plugins/grouped_layer_control.md index b100e7e4a1..c67c2546ba 100644 --- a/docs/user_guide/plugins/grouped_layer_control.md +++ b/docs/user_guide/plugins/grouped_layer_control.md @@ -59,3 +59,25 @@ GroupedLayerControl( m ``` + +To toggle every layer in a group at once, set `group_checkboxes=True` together with +`exclusive_groups=False`. This adds a checkbox next to each group label. Group +checkboxes are disabled by default and do not apply to exclusive groups. + +```{code-cell} ipython3 +m = folium.Map([40., 70.], zoom_start=6) + +fg1 = folium.FeatureGroup(name='g1', show=False).add_to(m) +fg2 = folium.FeatureGroup(name='g2', show=False).add_to(m) +folium.Marker([40, 74]).add_to(fg1) +folium.Marker([38, 72]).add_to(fg2) + +GroupedLayerControl( + groups={'groups1': [fg1, fg2]}, + exclusive_groups=False, + group_checkboxes=True, + collapsed=False, +).add_to(m) + +m +``` diff --git a/folium/plugins/groupedlayercontrol.py b/folium/plugins/groupedlayercontrol.py index 1167871903..65bd140ac7 100644 --- a/folium/plugins/groupedlayercontrol.py +++ b/folium/plugins/groupedlayercontrol.py @@ -27,6 +27,9 @@ class GroupedLayerControl(JSCSSMixin, MacroElement): Layer objects, typically tile layers, to show as base layers in this control. These are removed from the regular LayerControl. Use the layers' `show` argument to choose which one is shown on opening. + group_checkboxes : bool, default False + Show a checkbox next to each non-exclusive group label to toggle all + layers in that group. Use with `exclusive_groups=False`. **kwargs Additional (possibly inherited) options. See https://leafletjs.com/reference-1.9.4.html#control-layers @@ -77,12 +80,21 @@ class GroupedLayerControl(JSCSSMixin, MacroElement): {% endmacro %} """) - def __init__(self, groups, exclusive_groups=True, base_layers=None, **kwargs): + def __init__( + self, + groups, + exclusive_groups=True, + base_layers=None, + group_checkboxes=False, + **kwargs, + ): super().__init__() self._name = "GroupedLayerControl" self.options = remove_empty(**kwargs) if exclusive_groups: self.options["exclusiveGroups"] = list(groups.keys()) + if group_checkboxes: + self.options["groupCheckboxes"] = group_checkboxes self.base_layers = {} for element in base_layers or []: self.base_layers[element.layer_name] = element.get_name() diff --git a/tests/plugins/test_grouped_layer_control.py b/tests/plugins/test_grouped_layer_control.py index b3fb824705..395277eb35 100644 --- a/tests/plugins/test_grouped_layer_control.py +++ b/tests/plugins/test_grouped_layer_control.py @@ -1,3 +1,5 @@ +import pytest + import folium from folium.plugins import groupedlayercontrol from folium.utilities import normalize @@ -41,15 +43,22 @@ def test_grouped_layer_control(): assert expected in out -def test_grouped_layer_control_base_layers(): +@pytest.mark.parametrize("positional", [False, True]) +def test_grouped_layer_control_base_layers(positional): m = folium.Map([40.0, 70.0], zoom_start=6, tiles=None) osm = folium.TileLayer("OpenStreetMap", name="osm").add_to(m) topo = folium.TileLayer("OpenTopoMap", name="topo", show=False).add_to(m) fg1 = folium.FeatureGroup(name="g1").add_to(m) fg2 = folium.FeatureGroup(name="g2").add_to(m) - groupedlayercontrol.GroupedLayerControl( - groups={"groups1": [fg1, fg2]}, base_layers=[osm, topo] - ).add_to(m) + if positional: + control = groupedlayercontrol.GroupedLayerControl( + {"groups1": [fg1, fg2]}, True, [osm, topo] + ) + else: + control = groupedlayercontrol.GroupedLayerControl( + groups={"groups1": [fg1, fg2]}, base_layers=[osm, topo] + ) + control.add_to(m) lc = folium.LayerControl().add_to(m) out = normalize(m._parent.render()) @@ -71,3 +80,52 @@ def test_grouped_layer_control_base_layers(): assert expected in out # The base layers are no longer listed in the regular LayerControl. assert not lc.base_layers + + +@pytest.mark.parametrize("exclusive_groups", [False, True]) +@pytest.mark.parametrize("group_checkboxes", [False, True]) +def test_grouped_layer_control_group_checkboxes(exclusive_groups, group_checkboxes): + m = folium.Map([40.0, 70.0], zoom_start=6, tiles=None) + osm = folium.TileLayer("OpenStreetMap", name="osm").add_to(m) + fg1 = folium.FeatureGroup(name="g1").add_to(m) + fg2 = folium.FeatureGroup(name="g2").add_to(m) + hidden = folium.FeatureGroup(name="hidden", show=False).add_to(m) + groupedlayercontrol.GroupedLayerControl( + groups={"groups1": [fg1, fg2, hidden]}, + exclusive_groups=exclusive_groups, + base_layers=[osm], + group_checkboxes=group_checkboxes, + collapsed=False, + ).add_to(m) + lc = folium.LayerControl().add_to(m) + out = normalize(m._parent.render()) + + assert ('"groupCheckboxes": true' in out) == group_checkboxes + assert ('"exclusiveGroups": ["groups1",]' in out) == exclusive_groups + assert (f"{fg2.get_name()}.remove();" in out) == exclusive_groups + assert f"{fg1.get_name()}.remove();" not in out + assert f"{hidden.get_name()}.remove();" in out + assert '"collapsed": false' in out + assert f'"osm" : {osm.get_name()}' in out + assert not lc.base_layers + assert not lc.overlays + + +def test_grouped_layer_control_group_checkboxes_default(): + m = folium.Map() + fg = folium.FeatureGroup(name="g1").add_to(m) + groupedlayercontrol.GroupedLayerControl( + groups={"groups1": [fg]}, exclusive_groups=False + ).add_to(m) + + assert '"groupCheckboxes"' not in m._parent.render() + + +def test_grouped_layer_control_group_checkboxes_camel_case(): + m = folium.Map() + fg = folium.FeatureGroup(name="g1").add_to(m) + groupedlayercontrol.GroupedLayerControl( + groups={"groups1": [fg]}, exclusive_groups=False, groupCheckboxes=True + ).add_to(m) + + assert '"groupCheckboxes": true' in m._parent.render()