Merge pull request matplotlib#23197 from oscargus/pantests

Add tests for pan

Author: jklymak

lib/matplotlib/tests/test_backend_bases.py

@@ -180,7 +180,8 @@ def test_interactive_zoom():
 @pytest.mark.parametrize("tool,button,expected",
                          [("zoom", MouseButton.LEFT, (4, 6)),  # zoom in
                           ("zoom", MouseButton.RIGHT, (-20, 30)),  # zoom out
-                          ("pan", MouseButton.LEFT, (-2, 8))])
+                          ("pan", MouseButton.LEFT, (-2, 8)),
+                          ("pan", MouseButton.RIGHT, (1.47, 7.78))])  # zoom
 def test_interactive_colorbar(plot_func, orientation, tool, button, expected):
     fig, ax = plt.subplots()
     data = np.arange(12).reshape((4, 3))
@@ -284,3 +285,57 @@ def test_draw(backend):
 
     for ref, test in zip(layed_out_pos_agg, layed_out_pos_test):
         np.testing.assert_allclose(ref, test, atol=0.005)
+
+
+@pytest.mark.parametrize(
+    "key,mouseend,expectedxlim,expectedylim",
+    [(None, (0.2, 0.2), (3.49, 12.49), (2.7, 11.7)),
+     (None, (0.2, 0.5), (3.49, 12.49), (0, 9)),
+     (None, (0.5, 0.2), (0, 9), (2.7, 11.7)),
+     (None, (0.5, 0.5), (0, 9), (0, 9)),  # No move
+     (None, (0.8, 0.25), (-3.47, 5.53), (2.25, 11.25)),
+     (None, (0.2, 0.25), (3.49, 12.49), (2.25, 11.25)),
+     (None, (0.8, 0.85), (-3.47, 5.53), (-3.14, 5.86)),
+     (None, (0.2, 0.85), (3.49, 12.49), (-3.14, 5.86)),
+     ("shift", (0.2, 0.4), (3.49, 12.49), (0, 9)),  # snap to x
+     ("shift", (0.4, 0.2), (0, 9), (2.7, 11.7)),  # snap to y
+     ("shift", (0.2, 0.25), (3.49, 12.49), (3.49, 12.49)),  # snap to diagonal
+     ("shift", (0.8, 0.25), (-3.47, 5.53), (3.47, 12.47)),  # snap to diagonal
+     ("shift", (0.8, 0.9), (-3.58, 5.41), (-3.58, 5.41)),  # snap to diagonal
+     ("shift", (0.2, 0.85), (3.49, 12.49), (-3.49, 5.51)),  # snap to diagonal
+     ("x", (0.2, 0.1), (3.49, 12.49), (0, 9)),  # only x
+     ("y", (0.1, 0.2), (0, 9), (2.7, 11.7)),  # only y
+     ("control", (0.2, 0.2), (3.49, 12.49), (3.49, 12.49)),  # diagonal
+     ("control", (0.4, 0.2), (2.72, 11.72), (2.72, 11.72)),  # diagonal
+     ])
+def test_interactive_pan(key, mouseend, expectedxlim, expectedylim):
+    fig, ax = plt.subplots()
+    ax.plot(np.arange(10))
+    assert ax.get_navigate()
+    # Set equal aspect ratio to easier see diagonal snap
+    ax.set_aspect('equal')
+
+    # Mouse move starts from 0.5, 0.5
+    mousestart = (0.5, 0.5)
+    # Convert to screen coordinates ("s").  Events are defined only with pixel
+    # precision, so round the pixel values, and below, check against the
+    # corresponding xdata/ydata, which are close but not equal to d0/d1.
+    sstart = ax.transData.transform(mousestart).astype(int)
+    send = ax.transData.transform(mouseend).astype(int)
+
+    # Set up the mouse movements
+    start_event = MouseEvent(
+        "button_press_event", fig.canvas, *sstart, button=MouseButton.LEFT,
+        key=key)
+    stop_event = MouseEvent(
+        "button_release_event", fig.canvas, *send, button=MouseButton.LEFT,
+        key=key)
+
+    tb = NavigationToolbar2(fig.canvas)
+    tb.pan()
+    tb.press_pan(start_event)
+    tb.drag_pan(stop_event)
+    tb.release_pan(stop_event)
+    # Should be close, but won't be exact due to screen integer resolution
+    assert tuple(ax.get_xlim()) == pytest.approx(expectedxlim, abs=0.02)
+    assert tuple(ax.get_ylim()) == pytest.approx(expectedylim, abs=0.02)