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.

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

Default the layer manager to be opened on map initialization and other toolbar tweaks #2039

Merged
merged 7 commits into from
Jun 14, 2024
2 changes: 2 additions & 0 deletions geemap/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -641,6 +641,8 @@ def _add_toolbar(self, position: str, **kwargs) -> None:
widget=toolbar_val, position=position
)
super().add(toolbar_control)
# Enable the layer manager by default.
toolbar_val.toggle_layers(True)

def _add_inspector(self, position: str, **kwargs) -> None:
if self._inspector:
Expand Down
44 changes: 24 additions & 20 deletions geemap/toolbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,25 +151,31 @@ def returned_callback(change):
layout=widgets.Layout(height="28px", width="72px"),
)

self.toolbar_header = widgets.HBox()
self.toolbar_header = widgets.HBox(
layout=widgets.Layout(
display="flex", justify_content="flex-end", align_items="center"
)
)
self.toolbar_header.children = [self.layers_button, self.toolbar_button]
self.toolbar_footer = widgets.VBox()
self.toolbar_footer.children = [self.grid]

self.toolbar_button.observe(self._toolbar_btn_click, "value")
self.layers_button.observe(self._layers_btn_click, "value")

super().__init__(children=[self.toolbar_button])
toolbar_event = ipyevents.Event(
source=self, watched_events=["mouseenter", "mouseleave"]
)
toolbar_event.on_dom_event(self._handle_toolbar_event)
super().__init__(children=[self.toolbar_header])

def reset(self):
"""Resets the toolbar so that no widget is selected."""
for widget in self.all_widgets:
widget.value = False

def toggle_layers(self, enabled):
self.layers_button.value = enabled
self.on_layers_toggled(enabled)
if enabled:
self.toolbar_button.value = False

def _reset_others(self, current):
for other in self.all_widgets:
if other is not current:
Expand All @@ -194,22 +200,24 @@ def _toggle_callback(self, m, selected, item):
self.toggle_widget.tooltip = self._TOGGLE_TOOL_EXPAND_TOOLTIP
self.toggle_widget.icon = self._TOGGLE_TOOL_EXPAND_ICON

def _handle_toolbar_event(self, event):
if event["type"] == "mouseenter":
self.children = [self.toolbar_header, self.toolbar_footer]
elif event["type"] == "mouseleave":
if not self.toolbar_button.value:
self.children = [self.toolbar_button]
self.toolbar_button.value = False
self.layers_button.value = False

def _toolbar_btn_click(self, change):
if change["new"]:
self.layers_button.value = False
self.children = [self.toolbar_header, self.toolbar_footer]
else:
if not self.layers_button.value:
self.children = [self.toolbar_button]
self.children = [self.toolbar_header]

def _layers_btn_click(self, change):
# Allow callbacks to set accessory_widget to prevent flicker on click.
if self.on_layers_toggled:
self.on_layers_toggled(change["new"])
if change["new"]:
self.toolbar_button.value = False
self.children = [self.toolbar_header, self.toolbar_footer]
else:
if not self.toolbar_button.value:
self.children = [self.toolbar_header]

@property
def accessory_widget(self):
Expand All @@ -225,10 +233,6 @@ def accessory_widget(self, value):
else:
self.toolbar_footer.children = [self.grid]

def _layers_btn_click(self, change):
if self.on_layers_toggled:
self.on_layers_toggled(change["new"])


def inspector_gui(m=None):
"""Generates a tool GUI template using ipywidgets.
Expand Down
35 changes: 32 additions & 3 deletions tests/test_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import ipyleaflet
import ipywidgets

from geemap import core, toolbar
from geemap import core, map_widgets, toolbar
from tests import fake_ee, fake_map, utils


Expand Down Expand Up @@ -133,16 +133,45 @@ def test_add_toolbar(self):

self.assertEqual(len(self.core_map.controls), 1)
toolbar_control = self.core_map.controls[0].widget
utils.query_widget(
# Layer manager is selected and open by default.
layer_button = utils.query_widget(
toolbar_control, ipywidgets.ToggleButton, lambda c: c.tooltip == "Layers"
)
self.assertTrue(layer_button.value)
self.assertIsNotNone(
utils.query_widget(toolbar_control, map_widgets.LayerManager)
)

toolbar_button = utils.query_widget(
toolbar_control, ipywidgets.ToggleButton, lambda c: c.tooltip == "Toolbar"
).value = True # Open the grid of tools.
)
toolbar_button.value = True # Open the grid of tools.
self.assertFalse(layer_button.value)

tool_grid = utils.query_widget(toolbar_control, ipywidgets.GridBox).children

self.assertEqual(len(tool_grid), 3)
self.assertEqual(tool_grid[0].tooltip, "Basemap selector")
self.assertEqual(tool_grid[1].tooltip, "Inspector")
self.assertEqual(tool_grid[2].tooltip, "Get help")

# Closing the toolbar button shows both buttons in the header.
toolbar_button.value = False
self.assertIsNotNone(
utils.query_widget(
toolbar_control,
ipywidgets.ToggleButton,
lambda c: c.tooltip == "Toolbar",
)
)
self.assertIsNotNone(
utils.query_widget(
toolbar_control,
ipywidgets.ToggleButton,
lambda c: c.tooltip == "Layers",
)
)

def test_add_draw_control(self):
"""Tests adding and getting the draw widget."""

Expand Down
Loading