matplotlib.widgets._SelectorWidget

class matplotlib.widgets._SelectorWidget(ax, onselect=None, useblit=False, button=None, state_modifier_keys=None, use_data_coordinates=False)

Bases: AxesWidget

The base class for selector widgets.

This class provides common functionality for selector widgets, such as handling mouse and keyboard events, managing state modifier keys, etc.

The class itself is private and may be changed or removed without prior warning. However, the public API it provides to subclasses is stable and considered public on the subclasses.

add_state(state)

Add a state to define the widget's behavior. See the state_modifier_keys parameter in the constructor of the concrete selector class for details.

Parameters:

statestr

Must be a supported state of the selector. See the state_modifier_keys parameter in the constructor of the concrete selector class for details.

Raises:

ValueError

When the state is not supported by the selector.

property artists

Tuple of the artists of the selector.

clear()

Clear the selection and set the selector ready to make a new one.

connect_default_events()

Connect the major canvas events to methods.

get_visible()

Get the visibility of the selector artists.

ignore(event)

Return whether event should be ignored.

This method should be called at the beginning of any event callback.

on_key_press(event)

Key press event handler and validator for all selection widgets.

on_key_release(event)

Key release event handler and validator.

on_scroll(event)

Mouse scroll event handler and validator.

onmove(event)

Cursor move event handler and validator.

press(event)

Button press handler and validator.

release(event)

Button release event handler and validator.

remove_state(state)

Remove a state to define the widget's behavior. See the state_modifier_keys parameter in the constructor of the concrete selector class for details.

Parameters:

statestr

Must be a supported state of the selector. See the state_modifier_keys parameter in the constructor of the concrete selector class for details.

Raises:

ValueError

When the state is not supported by the selector.

set_active(active)

Set whether the widget is active.

set_handle_props(**handle_props)

Set the properties of the handles selector artist. See the handle_props argument in the selector docstring to know which properties are supported.

set_props(**props)

Set the properties of the selector artist.

See the props argument in the selector docstring to know which properties are supported.

set_visible(visible)

Set the visibility of the selector artists.

update()

Draw using blit() or draw_idle(), depending on self.useblit.

update_background(event)

Force an update of the background.

property useblit

Return whether blitting is used (requested and supported by canvas).

Examples using matplotlib.widgets._SelectorWidget

Select indices from a collection using polygon selector

Select indices from a collection using polygon selector

Polygon Selector

Polygon Selector

Rectangle and ellipse selectors

Rectangle and ellipse selectors

Span Selector

Span Selector