Replace on_click with on_mouse_down, update documentation

Author: davidbrochart

docs/source/events.rst

@@ -4,7 +4,7 @@ Interactions
 Using built-in events
 ---------------------
 
-There are currently two built-in mouse events: ``click`` and ``mouse_move``.
+The following built-in mouse events are supported: ``mouse_down``, ``mouse_move``, ``mouse_up`` and ``mouse_out``.
 
 .. code:: Python
 
@@ -14,11 +14,11 @@ There are currently two built-in mouse events: ``click`` and ``mouse_move``.
 
     canvas.on_mouse_move(handle_mouse_move)
 
-    def handle_click(x, y):
+    def handle_mouse_down(x, y):
         # Do something else
         pass
 
-    canvas.on_click(handle_click)
+    canvas.on_mouse_down(handle_mouse_down)
 
 .. note::
     Please open an issue or a Pull Request if you want more events to be supported by ipycanvas

examples/plotting.ipynb

@@ -132,7 +132,10 @@
     "        self.canvas[2].on_mouse_down(self.mouse_down_handler)\n",
     "        self.canvas[2].on_mouse_move(self.mouse_move_handler)\n",
     "        self.canvas[2].on_mouse_up(self.mouse_up_handler)\n",
-    "    \n",
+    "\n",
+    "    def _ipython_display_(self):\n",
+    "        display(self.canvas)\n",
+    "\n",
     "    def show(self):\n",
     "        with hold_canvas(self.canvas):\n",
     "            self.canvas.clear()\n",
@@ -170,7 +173,7 @@
     "                break\n",
     "                \n",
     "    def mouse_move_handler(self, pixel_x, pixel_y):\n",
-    "        if (self.dragging):\n",
+    "        if self.dragging:\n",
     "            unscaled_x = self.unscale_x(pixel_x)\n",
     "            unscaled_y = self.unscale_y(pixel_y)\n",
     "            self.x[self.i_mark] = unscaled_x\n",
@@ -297,7 +300,7 @@
     "sizes = np.random.randint(2, 8, n_points)\n",
     "colors = np.random.rand(n_points) * 10 - 2\n",
     "\n",
-    "plot = Scatter_plot(x, y, sizes, colors, branca.colormap.linear.viridis, stroke_color='white').canvas\n",
+    "plot = Scatter_plot(x, y, sizes, colors, branca.colormap.linear.viridis, stroke_color='white')\n",
     "plot"
    ]
   },

ipycanvas/canvas.py

@@ -112,7 +112,6 @@ class Canvas(DOMWidget):
     _mouse_down_callbacks = Instance(CallbackDispatcher, ())
     _mouse_up_callbacks = Instance(CallbackDispatcher, ())
     _mouse_out_callbacks = Instance(CallbackDispatcher, ())
-    _click_callbacks = Instance(CallbackDispatcher, ())
 
     def __init__(self, *args, **kwargs):
         """Create a Canvas widget."""
@@ -460,10 +459,6 @@ def on_mouse_out(self, callback, remove=False):
         """Register a callback that will be called on mouse mouse_out."""
         self._mouse_out_callbacks.register_callback(callback, remove=remove)
 
-    def on_click(self, callback, remove=False):
-        """Register a callback that will be called on mouse click."""
-        self._click_callbacks.register_callback(callback, remove=remove)
-
     def __setattr__(self, name, value):
         super(Canvas, self).__setattr__(name, value)
 
@@ -500,7 +495,6 @@ def _handle_frontend_event(self, _, content, buffers):
         if content.get('event', '') == 'mouse_move':
             self._mouse_move_callbacks(content['x'], content['y'])
         if content.get('event', '') == 'mouse_down':
-            self._click_callbacks(content['x'], content['y'])
             self._mouse_down_callbacks(content['x'], content['y'])
         if content.get('event', '') == 'mouse_up':
             self._mouse_up_callbacks(content['x'], content['y'])

src/widget.ts

@@ -320,7 +320,6 @@ class CanvasView extends DOMWidgetView {
   }
 
   private onMouseDown(event: MouseEvent) {
-    this.model.send({ event: 'click', ...this.getMouseCoordinate(event) }, {});
     this.model.send({ event: 'mouse_down', ...this.getMouseCoordinate(event) }, {});
   }