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

Added wheel support #321

Merged
merged 2 commits into from
Apr 25, 2024
Merged

Added wheel support #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e50a4cd
Added wheel support
VladislavZavadskyy Feb 11, 2023
7129e81
Updated docs
VladislavZavadskyy Feb 11, 2023
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
11 changes: 11 additions & 0 deletions ipycanvas/canvas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,7 @@ class Canvas(_CanvasBase):

_client_ready_callbacks = Instance(CallbackDispatcher, ())

_mouse_wheel_callbacks = Instance(CallbackDispatcher, ())
_mouse_move_callbacks = Instance(CallbackDispatcher, ())
_mouse_down_callbacks = Instance(CallbackDispatcher, ())
_mouse_up_callbacks = Instance(CallbackDispatcher, ())
Expand Down Expand Up @@ -1507,6 +1508,10 @@ def on_mouse_out(self, callback, remove=False):
"""Register a callback that will be called on mouse out of the canvas."""
self._mouse_out_callbacks.register_callback(callback, remove=remove)

def on_mouse_wheel(self, callback, remove=False):
"""Register a callback that will be called on mouse wheel movement."""
self._mouse_wheel_callbacks.register_callback(callback, remove=remove)

def on_touch_start(self, callback, remove=False):
"""Register a callback that will be called on touch start (new finger on the screen)."""
self._touch_start_callbacks.register_callback(callback, remove=remove)
Expand Down Expand Up @@ -1551,6 +1556,8 @@ def _handle_frontend_event(self, _, content, buffers):
self._mouse_up_callbacks(content["x"], content["y"])
if content.get("event", "") == "mouse_out":
self._mouse_out_callbacks(content["x"], content["y"])
if content.get("event", "") == "mouse_wheel":
self._mouse_wheel_callbacks(content["x"], content["y"])

if content.get("event", "") == "touch_start":
self._touch_start_callbacks(
Expand Down Expand Up @@ -1749,6 +1756,10 @@ def on_mouse_out(self, callback, remove=False):
"""Register a callback that will be called on mouse out of the canvas."""
self._canvases[-1].on_mouse_out(callback, remove=remove)

def on_mouse_wheel(self, callback, remove=False):
"""Register a callback that will be called on mouse wheel movement."""
self._canvases[-1].on_mouse_wheel(callback, remove=remove)

def on_touch_start(self, callback, remove=False):
"""Register a callback that will be called on touch start (new finger on the screen)."""
self._canvases[-1].on_touch_start(callback, remove=remove)
Expand Down
11 changes: 11 additions & 0 deletions src/widget.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1338,6 +1338,9 @@ export class CanvasView extends DOMWidgetView {
this.el.addEventListener('mouseout', {
handleEvent: this.onMouseOut.bind(this)
});
this.el.addEventListener('wheel', {
handleEvent: this.onMouseWheel.bind(this)
});
this.el.addEventListener('touchstart', {
handleEvent: this.onTouchStart.bind(this)
});
Expand Down Expand Up @@ -1392,6 +1395,14 @@ export class CanvasView extends DOMWidgetView {
this.model.send({ event: 'mouse_out', ...this.getCoordinates(event) }, {});
}

private onMouseWheel(event: WheelEvent) {
this.model.send(
{ event: 'mouse_wheel', x: event.deltaX, y: event.deltaY },
{}
);
event.preventDefault();
}

private onTouchStart(event: TouchEvent) {
const touches: Touch[] = Array.from(event.touches);
this.model.send(
Expand Down