Merge pull request #20585 from ericpre/rename_parameter_selectors

timhoffm · web-flow · commit 9869421030a9 · 2021-07-19T14:02:41.000+02:00
Rename parameter selectors
diff --git a/doc/api/next_api_changes/deprecations/20585-EP.rst b/doc/api/next_api_changes/deprecations/20585-EP.rst
@@ -0,0 +1,32 @@
+Unification of Selector API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The API for Selector widgets has been unified to use
+
+- *props* for the properties of the Artist representing the selection.
+- *handle_props* for the Artists representing handles for modifying the selection.
+- *grab_range* for the maximal tolerance to grab a handle with the mouse.
+
+This affects the following parameters and attributes:
+
+
+RectangleSelector and EllipseSelector
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The *maxdist* argument is deprecated, use *grab_range* instead.
+The *rectprops* argument is deprecated, use *props* instead.
+The *marker_props* argument is deprecated, use *handle_props* instead.
+
+PolygonSelector
+^^^^^^^^^^^^^^^
+The *vertex_select_radius* argument and attribute is deprecated, use *grab_range* instead.
+The *lineprops* argument is deprecated, use *props* instead.
+The *markerprops* argument is deprecated, use *handle_props* instead.
+The *maxdist* argument and attribute is deprecated, use *grab_range* instead.
+
+SpanSelector
+^^^^^^^^^^^^
+The *rectprops* argument is deprecated, use *props* instead.
+The *maxdist* argument and attribute is deprecated, use *grab_range* instead.
+
+LassoSelector
+^^^^^^^^^^^^^
+The *lineprops* argument is deprecated, use *props* instead.
diff --git a/examples/widgets/span_selector.py b/examples/widgets/span_selector.py
@@ -53,7 +53,7 @@ def onselect(xmin, xmax):
     onselect,
     "horizontal",
     useblit=True,
-    rectprops=dict(alpha=0.5, facecolor="tab:blue"),
+    props=dict(alpha=0.5, facecolor="tab:blue"),
     interactive=True,
     drag_from_anywhere=True
 )
diff --git a/lib/matplotlib/tests/test_widgets.py b/lib/matplotlib/tests/test_widgets.py
@@ -52,7 +52,7 @@ def test_rectangle_selector():
         check_rectangle(drawtype='none', minspanx=10, minspany=10)
 
     check_rectangle(minspanx=10, minspany=10, spancoords='pixels')
-    check_rectangle(rectprops=dict(fill=True))
+    check_rectangle(props=dict(fill=True))
 
 
 @pytest.mark.parametrize('drag_from_anywhere, new_center',
@@ -98,7 +98,7 @@ def onselect(epress, erelease):
         pass
 
     tool = widgets.EllipseSelector(ax, onselect=onselect,
-                                   maxdist=10, interactive=True)
+                                   grab_range=10, interactive=True)
     tool.extents = (100, 150, 100, 150)
 
     # drag the rectangle
@@ -152,8 +152,9 @@ def onselect(epress, erelease):
         pass
 
     tool = widgets.RectangleSelector(ax, onselect=onselect,
-                                     maxdist=10, interactive=True,
-                                     marker_props={'markerfacecolor': 'r',
+                                     grab_range=10,
+                                     interactive=True,
+                                     handle_props={'markerfacecolor': 'r',
                                                    'markeredgecolor': 'b'})
     tool.extents = (100, 150, 100, 150)
 
@@ -220,7 +221,7 @@ def onmove(vmin, vmax):
 def test_span_selector():
     check_span('horizontal', minspan=10, useblit=True)
     check_span('vertical', onmove_callback=True, button=1)
-    check_span('horizontal', rectprops=dict(fill=True))
+    check_span('horizontal', props=dict(fill=True))
 
 
 @pytest.mark.parametrize('drag_from_anywhere', [True, False])
@@ -319,7 +320,7 @@ def onselect(verts):
 
 def test_lasso_selector():
     check_lasso_selector()
-    check_lasso_selector(useblit=False, lineprops=dict(color='red'))
+    check_lasso_selector(useblit=False, props=dict(color='red'))
     check_lasso_selector(useblit=True, button=1)
 
 
@@ -673,7 +674,7 @@ def onselect(verts):
         pass
 
     tool = widgets.RectangleSelector(ax_test, onselect,
-                                     rectprops={'visible': False})
+                                     props={'visible': False})
     tool.extents = (0.2, 0.8, 0.3, 0.7)
 
 
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ def onselect(xmin, xmax):`
`53`	`53`	`onselect,`
`54`	`54`	`"horizontal",`
`55`	`55`	`useblit=True,`
`56`		`- rectprops=dict(alpha=0.5, facecolor="tab:blue"),`
	`56`	`+ props=dict(alpha=0.5, facecolor="tab:blue"),`
`57`	`57`	`interactive=True,`
`58`	`58`	`drag_from_anywhere=True`
`59`	`59`	`)`