|
| 1 | +Removal of deprecations in the Selector widget API |
| 2 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 3 | + |
| 4 | +RectangleSelector and EllipseSelector |
| 5 | +..................................... |
| 6 | + |
| 7 | +The *drawtype* keyword argument to `~matplotlib.widgets.RectangleSelector` is |
| 8 | +removed. From now on, the only behaviour will be ``drawtype='box'``. |
| 9 | + |
| 10 | +Support for ``drawtype=line`` is removed altogether. As a |
| 11 | +result, the *lineprops* keyword argument to |
| 12 | +`~matplotlib.widgets.RectangleSelector` is also removed. |
| 13 | + |
| 14 | +To retain the behaviour of ``drawtype='none'``, use ``rectprops={'visible': |
| 15 | +False}`` to make the drawn `~matplotlib.patches.Rectangle` invisible. |
| 16 | + |
| 17 | +Cleaned up attributes and arguments are: |
| 18 | + |
| 19 | +- The ``active_handle`` attribute has been privatized and removed. |
| 20 | +- The ``drawtype`` attribute has been privatized and removed. |
| 21 | +- The ``eventpress`` attribute has been privatized and removed. |
| 22 | +- The ``eventrelease`` attribute has been privatized and removed. |
| 23 | +- The ``interactive`` attribute has been privatized and removed. |
| 24 | +- The *marker_props* argument is removed, use *handle_props* instead. |
| 25 | +- The *maxdist* argument is removed, use *grab_range* instead. |
| 26 | +- The *rectprops* argument is removed, use *props* instead. |
| 27 | +- The ``rectprops`` attribute has been privatized and removed. |
| 28 | +- The ``state`` attribute has been privatized and removed. |
| 29 | +- The ``to_draw`` attribute has been privatized and removed. |
| 30 | + |
| 31 | +PolygonSelector |
| 32 | +............... |
| 33 | + |
| 34 | +- The *line* attribute is removed. If you want to change the selector artist |
| 35 | + properties, use the ``set_props`` or ``set_handle_props`` methods. |
| 36 | +- The *lineprops* argument is removed, use *props* instead. |
| 37 | +- The *markerprops* argument is removed, use *handle_props* instead. |
| 38 | +- The *maxdist* argument and attribute is removed, use *grab_range* instead. |
| 39 | +- The *vertex_select_radius* argument and attribute is removed, use |
| 40 | + *grab_range* instead. |
| 41 | + |
| 42 | +SpanSelector |
| 43 | +............ |
| 44 | + |
| 45 | +- The ``active_handle`` attribute has been privatized and removed. |
| 46 | +- The ``eventpress`` attribute has been privatized and removed. |
| 47 | +- The ``eventrelease`` attribute has been privatized and removed. |
| 48 | +- The ``pressv`` attribute has been privatized and removed. |
| 49 | +- The ``prev`` attribute has been privatized and removed. |
| 50 | +- The ``rect`` attribute has been privatized and removed. |
| 51 | +- The *rectprops* parameter has been renamed to *props*. |
| 52 | +- The ``rectprops`` attribute has been privatized and removed. |
| 53 | +- The *span_stays* parameter has been renamed to *interactive*. |
| 54 | +- The ``span_stays`` attribute has been privatized and removed. |
| 55 | +- The ``state`` attribute has been privatized and removed. |
| 56 | + |
| 57 | +LassoSelector |
| 58 | +............. |
| 59 | + |
| 60 | +- The *lineprops* argument is removed, use *props* instead. |
| 61 | +- The ``onpress`` and ``onrelease`` methods are removed. They are straight |
| 62 | + aliases for ``press`` and ``release``. |
| 63 | +- The ``matplotlib.widgets.TextBox.DIST_FROM_LEFT`` attribute has been |
| 64 | + removed. It was marked as private in 3.5. |
0 commit comments