To guarantee that the selector remains responsive, keep a reference to it.

In order to turn off the SpanSelector, set span_selector.active to False. To turn it back on, set it to True.

Press and release events triggered at the same coordinates outside the selection will clear the selector, except when ignore_event_outside=True .

Parameters

ax : `matplotlib.axes.Axes`

onselect : callable

A callback function that is called after a release event and the selection is created, changed or removed. It must have the signature:

def on_select(min: float, max: float) -> Any

direction : {"horizontal", "vertical"}

The direction along which to draw the span selector.

minspan : float, default: 0

If selection is less than or equal to minspan, the selection is removed (when already existing) or cancelled.

useblit : bool, default: False

If True, use the backend-dependent blitting features for faster canvas updates.

props : dict, optional

Dictionary of matplotlib.patches.Patch properties. Default:

dict(facecolor='red', alpha=0.5)

onmove_callback : func(min, max), min/max are floats, default: None

Called on mouse move while the span is being selected.

span_stays : bool, default: False

If True, the span stays visible after the mouse is released. Deprecated, use interactive instead.

interactive : bool, default: False

Whether to draw a set of handles that allow interaction with the widget after it is drawn.

button : `.MouseButton` or list of `.MouseButton`, default: all buttons

The mouse buttons which activate the span selector.

handle_props : dict, default: None

Properties of the handle lines at the edges of the span. Only used when interactive is True. See matplotlib.lines.Line2D for valid properties.

grab_range : float, default: 10

Distance in pixels within which the interactive tool handles can be activated.

drag_from_anywhere : bool, default: False

If :None:None:`True`, the widget can be moved by clicking anywhere within its bounds.

ignore_event_outside : bool, default: False

If :None:None:`True`, the event triggered outside the span selector will be ignored.

Visually select a min/max range on a single axis and call a function with those values.

Examples

>>> import matplotlib.pyplot as plt
... import matplotlib.widgets as mwidgets
... fig, ax = plt.subplots()
... ax.plot([1, 2, 3], [10, 50, 100])
... def onselect(vmin, vmax):
...     print(vmin, vmax)
... span = mwidgets.SpanSelector(ax, onselect, 'horizontal',
...                              props=dict(facecolor='blue', alpha=0.5))
... fig.show()

See also: /gallery/widgets/span_selector

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

matplotlib.widgets.LassoSelector matplotlib.widgets.SpanSelector

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /matplotlib/widgets.py#2063
type: <class 'type'>
Commit: