Merge pull request #235 from ianhi/capture-scroll

Add option to preventDefault on scroll event
matplotlib · Jun 18, 2020 · 6b44a6f · 6b44a6f
2 parents 7dabbff + c0c1004
commit 6b44a6f
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/examples/ipympl.ipynb b/examples/ipympl.ipynb
@@ -65,6 +65,15 @@
     "fig.canvas.resizable = False"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig.canvas.capture_scroll = True"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

diff --git a/ipympl/backend_nbagg.py b/ipympl/backend_nbagg.py
@@ -175,6 +175,7 @@ class Canvas(DOMWidget, FigureCanvasWebAggCore):
     footer_visible = Bool(True).tag(sync=True)
 
     resizable = Bool(True).tag(sync=True)
+    capture_scroll = Bool(False).tag(sync=True)
 
     _width = CInt().tag(sync=True)
     _height = CInt().tag(sync=True)

diff --git a/js/src/mpl_widget.js b/js/src/mpl_widget.js
@@ -21,6 +21,7 @@ export class MPLCanvasModel extends widgets.DOMWidgetModel {
             toolbar_visible: true,
             toolbar_position: 'horizontal',
             resizable: true,
+            capture_scroll: false,
             _width: 0,
             _height: 0,
             _figure_label: 'Figure',
@@ -565,6 +566,9 @@ export class MPLCanvasView extends widgets.DOMWidgetView {
                 } else {
                     event.step = -1;
                 }
+                if (this.model.get('capture_scroll')) {
+                    event.preventDefault();
+                }
             }
 
             if (name === 'button_press') {