diff --git a/doc/users/next_whats_new/scroll_to_zoom.rst b/doc/users/next_whats_new/scroll_to_zoom.rst
new file mode 100644
index 000000000000..13897b9b8045
--- /dev/null
+++ b/doc/users/next_whats_new/scroll_to_zoom.rst
@@ -0,0 +1,11 @@
+Scroll-to-zoom in GUIs
+~~~~~~~~~~~~~~~~~~~~~~
+
+When a plot manipulation tool (pan or zoom tool) in plot windows is enabled,
+a mouse scroll operation results in a zoom focussing on the mouse pointer, keeping the
+aspect ratio of the axes.
+
+There is no effect if no manipulation tool is selected. This is intentional to
+keep a state in which accidental manipulation of the plot is avoided.
+
+Zooming is currently only supported on rectilinear Axes.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
index 8107471955fe..815c61a0ee34 100644
--- a/lib/matplotlib/backend_bases.py
+++ b/lib/matplotlib/backend_bases.py
@@ -2574,6 +2574,42 @@ def button_press_handler(event, canvas=None, toolbar=None):
toolbar.forward()
+def scroll_handler(event, canvas=None, toolbar=None):
+ ax = event.inaxes
+ if ax is None:
+ return
+ if ax.name != "rectilinear":
+ # zooming is currently only supported on rectilinear axes
+ return
+
+ if toolbar is None:
+ toolbar = (canvas or event.canvas).toolbar
+
+ if toolbar is None or toolbar.mode == _Mode.NONE:
+ return
+
+ if event.key is None: # zoom towards the mouse position
+ toolbar.push_current()
+
+ xmin, xmax = ax.get_xlim()
+ ymin, ymax = ax.get_ylim()
+
+ # mouse position in data coordinates
+ x = event.xdata
+ y = event.ydata
+
+ scale_factor = 1.0 - 0.05 * event.step
+ new_xmin = x - (x - xmin) * scale_factor
+ new_xmax = x + (xmax - x) * scale_factor
+ new_ymin = y - (y - ymin) * scale_factor
+ new_ymax = y + (ymax - y) * scale_factor
+
+ ax.set_xlim(new_xmin, new_xmax)
+ ax.set_ylim(new_ymin, new_ymax)
+
+ ax.figure.canvas.draw_idle()
+
+
class NonGuiException(Exception):
"""Raised when trying show a figure in a non-GUI backend."""
pass
@@ -2653,11 +2689,14 @@ def __init__(self, canvas, num):
self.key_press_handler_id = None
self.button_press_handler_id = None
+ self.scroll_handler_id = None
if rcParams['toolbar'] != 'toolmanager':
self.key_press_handler_id = self.canvas.mpl_connect(
'key_press_event', key_press_handler)
self.button_press_handler_id = self.canvas.mpl_connect(
'button_press_event', button_press_handler)
+ self.scroll_handler_id = self.canvas.mpl_connect(
+ 'scroll_event', scroll_handler)
self.toolmanager = (ToolManager(canvas.figure)
if mpl.rcParams['toolbar'] == 'toolmanager'
diff --git a/lib/matplotlib/backend_bases.pyi b/lib/matplotlib/backend_bases.pyi
index c65d39415472..7a2b28262249 100644
--- a/lib/matplotlib/backend_bases.pyi
+++ b/lib/matplotlib/backend_bases.pyi
@@ -407,6 +407,11 @@ def button_press_handler(
canvas: FigureCanvasBase | None = ...,
toolbar: NavigationToolbar2 | None = ...,
) -> None: ...
+def scroll_handler(
+ event: MouseEvent,
+ canvas: FigureCanvasBase | None = ...,
+ toolbar: NavigationToolbar2 | None = ...,
+) -> None: ...
class NonGuiException(Exception): ...
@@ -415,6 +420,7 @@ class FigureManagerBase:
num: int | str
key_press_handler_id: int | None
button_press_handler_id: int | None
+ scroll_handler_id: int | None
toolmanager: ToolManager | None
toolbar: NavigationToolbar2 | ToolContainerBase | None
def __init__(self, canvas: FigureCanvasBase, num: int | str) -> None: ...
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy