Skip to content

Commit fefe2bb

Browse files
committed
implementing suggestions from Patrick
1 parent fbeda98 commit fefe2bb

3 files changed

Lines changed: 15 additions & 6 deletions

File tree

js/models/message_handler.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ export default class MessageHandler {
141141
}
142142

143143
handleRemoveOverlay = (msg) => {
144-
const overlay_names = msg["name"];
144+
const overlay_names = msg["overlay_names"];
145145
for (const overlay_name of overlay_names) {
146146
console.info(`Sending removeOverlay for ${overlay_name}`);
147147
this.aladin.removeOverlay(overlay_name);

src/ipyaladin/widget.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -985,12 +985,14 @@ def remove_overlay(self, overlay_name: Union[Iterable[str], str]) -> None:
985985
The string or an iterable of strings.
986986
987987
"""
988-
overlay_name = [overlay_name] if isinstance(overlay_name, str) else overlay_name
988+
overlay_names = (
989+
[overlay_name] if isinstance(overlay_name, str) else overlay_name
990+
)
989991

990992
self.send(
991993
{
992994
"event_name": "remove_overlay",
993-
"name": overlay_name,
995+
"overlay_names": overlay_names,
994996
}
995997
)
996998

@@ -1054,7 +1056,8 @@ def set_listener(self, listener_type: str, callback: Callable) -> None:
10541056
Parameters
10551057
----------
10561058
listener_type : str
1057-
Can either be 'object_hovered', 'object_clicked', 'click' or 'select'
1059+
Can either be 'object_hovered', 'object_clicked', 'click', 'select',
1060+
or 'current_overlays'
10581061
callback : Callable
10591062
A python function to be called when the event corresponding to the
10601063
listener_type is detected
@@ -1073,7 +1076,8 @@ def set_listener(self, listener_type: str, callback: Callable) -> None:
10731076
else:
10741077
raise ValueError(
10751078
"listener_type must be 'object_hovered', "
1076-
"'object_clicked', 'click' or 'select'"
1079+
"'object_clicked', 'click', 'select', "
1080+
"or 'current_overlays'"
10771081
)
10781082

10791083
@widget_should_be_loaded

src/tests/test_aladin.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,12 @@ def test_remove_overlay(
265265
mock_send = Mock()
266266
monkeypatch.setattr(Aladin, "send", mock_send)
267267
aladin.remove_overlay(overlay_names)
268-
name_info = mock_send.call_args[0][0]["name"]
268+
269+
event_name = mock_send.call_args[0][0]["event_name"]
270+
assert isinstance(event_name, str)
271+
assert event_name == "remove_overlay"
272+
273+
name_info = mock_send.call_args[0][0]["overlay_names"]
269274
assert isinstance(name_info, list)
270275
assert name_info[0] in overlay_names
271276

0 commit comments

Comments
 (0)