Merge pull request #20113 from ericpre/interactive_span_selector

QuLogic · web-flow · commit 401317268134 · 2021-06-30T17:23:22.000-04:00
Interactive span selector improvement
diff --git a/doc/api/next_api_changes/deprecations/20113-EP.rst b/doc/api/next_api_changes/deprecations/20113-EP.rst
@@ -0,0 +1,21 @@
+SpanSelector
+~~~~~~~~~~~~
+``span_stays`` is deprecated, use ``interactive`` argument instead
+Several `~matplotlib.widgets.SpanSelector` class internals have been privatized 
+and deprecated:
+- ``pressv``
+- ``prev``
+- ``rect``
+- ``rectprops``
+- ``active_handle``
+- ``span_stays``
+
+
+Several `~matplotlib.widgets.RectangleSelector` and
+`~matplotlib.widgets.EllipseSelector` class internals have been privatized and
+deprecated:
+- ``to_draw``
+- ``drawtype``
+- ``rectprops``
+- ``active_handle``
+- ``interactive``
diff --git a/doc/users/next_whats_new/widget_dragging.rst b/doc/users/next_whats_new/widget_dragging.rst
@@ -1,9 +1,12 @@
 Dragging selectors
 ------------------
 
-The `~matplotlib.widgets.RectangleSelector` and
-`~matplotlib.widgets.EllipseSelector` have a new keyword argument,
+The `~matplotlib.widgets.SpanSelector`, `~matplotlib.widgets.RectangleSelector`
+and `~matplotlib.widgets.EllipseSelector` have a new keyword argument,
 *drag_from_anywhere*, which when set to `True` allows you to click and drag
 from anywhere inside the selector to move it. Previously it was only possible
 to move it by either activating the move modifier button, or clicking on the
 central handle.
+
+The size of the `~matplotlib.widgets.SpanSelector` can now be changed using
+the edge handles.
diff --git a/examples/widgets/span_selector.py b/examples/widgets/span_selector.py
@@ -16,7 +16,7 @@
 fig, (ax1, ax2) = plt.subplots(2, figsize=(8, 6))
 
 x = np.arange(0.0, 5.0, 0.01)
-y = np.sin(2*np.pi*x) + 0.5*np.random.randn(len(x))
+y = np.sin(2 * np.pi * x) + 0.5 * np.random.randn(len(x))
 
 ax1.plot(x, y)
 ax1.set_ylim(-2, 2)
@@ -37,7 +37,8 @@ def onselect(xmin, xmax):
         line2.set_data(region_x, region_y)
         ax2.set_xlim(region_x[0], region_x[-1])
         ax2.set_ylim(region_y.min(), region_y.max())
-        fig.canvas.draw()
+        fig.canvas.draw_idle()
+
 
 #############################################################################
 # .. note::
@@ -47,8 +48,15 @@ def onselect(xmin, xmax):
 #
 
 
-span = SpanSelector(ax1, onselect, 'horizontal', useblit=True,
-                    rectprops=dict(alpha=0.5, facecolor='tab:blue'))
+span = SpanSelector(
+    ax1,
+    onselect,
+    "horizontal",
+    useblit=True,
+    rectprops=dict(alpha=0.5, facecolor="tab:blue"),
+    interactive=True,
+    drag_from_anywhere=True
+)
 # Set useblit=True on most backends for enhanced performance.
 
 
diff --git a/lib/matplotlib/tests/test_widgets.py b/lib/matplotlib/tests/test_widgets.py
@@ -195,20 +195,21 @@ def check_span(*args, **kwargs):
     def onselect(vmin, vmax):
         ax._got_onselect = True
         assert vmin == 100
-        assert vmax == 150
+        assert vmax == 199
 
     def onmove(vmin, vmax):
         assert vmin == 100
-        assert vmax == 125
+        assert vmax == 199
         ax._got_on_move = True
 
     if 'onmove_callback' in kwargs:
         kwargs['onmove_callback'] = onmove
 
     tool = widgets.SpanSelector(ax, onselect, *args, **kwargs)
     do_event(tool, 'press', xdata=100, ydata=100, button=1)
-    do_event(tool, 'onmove', xdata=125, ydata=125, button=1)
-    do_event(tool, 'release', xdata=150, ydata=150, button=1)
+    # move outside of axis
+    do_event(tool, 'onmove', xdata=199, ydata=199, button=1)
+    do_event(tool, 'release', xdata=250, ydata=250, button=1)
 
     assert ax._got_onselect
 
@@ -222,6 +223,85 @@ def test_span_selector():
     check_span('horizontal', rectprops=dict(fill=True))
 
 
+@pytest.mark.parametrize('drag_from_anywhere', [True, False])
+def test_span_selector_drag(drag_from_anywhere):
+    ax = get_ax()
+
+    def onselect(epress, erelease):
+        pass
+
+    # Create span
+    tool = widgets.SpanSelector(ax, onselect, 'horizontal', interactive=True,
+                                drag_from_anywhere=drag_from_anywhere)
+    do_event(tool, 'press', xdata=10, ydata=10, button=1)
+    do_event(tool, 'onmove', xdata=100, ydata=120, button=1)
+    do_event(tool, 'release', xdata=100, ydata=120, button=1)
+    assert tool.extents == (10, 100)
+    # Drag inside span
+    #
+    # If drag_from_anywhere == True, this will move the span by 10,
+    # giving new value extents = 20, 110
+    #
+    # If drag_from_anywhere == False, this will create a new span with
+    # value extents = 25, 35
+    do_event(tool, 'press', xdata=25, ydata=15, button=1)
+    do_event(tool, 'onmove', xdata=35, ydata=25, button=1)
+    do_event(tool, 'release', xdata=35, ydata=25, button=1)
+    if drag_from_anywhere:
+        assert tool.extents == (20, 110)
+    else:
+        assert tool.extents == (25, 35)
+
+    # Check that in both cases, dragging outside the span draws a new span
+    do_event(tool, 'press', xdata=175, ydata=185, button=1)
+    do_event(tool, 'onmove', xdata=185, ydata=195, button=1)
+    do_event(tool, 'release', xdata=185, ydata=195, button=1)
+    assert tool.extents == (175, 185)
+
+
+def test_span_selector_direction():
+    ax = get_ax()
+
+    def onselect(epress, erelease):
+        pass
+
+    tool = widgets.SpanSelector(ax, onselect, 'horizontal', interactive=True)
+    assert tool.direction == 'horizontal'
+    assert tool._edge_handles.direction == 'horizontal'
+
+    with pytest.raises(ValueError):
+        tool = widgets.SpanSelector(ax, onselect, 'invalid_direction')
+
+    tool.direction = 'vertical'
+    assert tool.direction == 'vertical'
+    assert tool._edge_handles.direction == 'vertical'
+
+    with pytest.raises(ValueError):
+        tool.direction = 'invalid_string'
+
+
+def test_tool_line_handle():
+    ax = get_ax()
+
+    positions = [20, 30, 50]
+
+    tool_line_handle = widgets.ToolLineHandles(ax, positions, 'horizontal',
+                                               useblit=False)
+
+    for artist in tool_line_handle.artists:
+        assert not artist.get_animated()
+        assert not artist.get_visible()
+
+    tool_line_handle.set_visible(True)
+    tool_line_handle.set_animated(True)
+
+    for artist in tool_line_handle.artists:
+        assert artist.get_animated()
+        assert artist.get_visible()
+
+    assert tool_line_handle.positions == positions
+
+
 def check_lasso_selector(**kwargs):
     ax = get_ax()
 
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
