matplotlib.pyplot.connect#

matplotlib.pyplot.connect(s, func)[source]#

Bind function func to event s.

Parameters:

sstr

One of the following events ids:

• 'button_press_event'

• 'button_release_event'

• 'draw_event'

• 'key_press_event'

• 'key_release_event'

• 'motion_notify_event'

• 'pick_event'

• 'resize_event'

• 'scroll_event'

• 'figure_enter_event',

• 'figure_leave_event',

• 'axes_enter_event',

• 'axes_leave_event'

• 'close_event'.

funccallable

The callback function to be executed, which must have the signature:

def func(event: Event) -> Any

For the location events (button and key press/release), if the mouse is over the Axes, the inaxes attribute of the event will be set to the Axes the event occurs is over, and additionally, the variables xdata and ydata attributes will be set to the mouse location in data coordinates. See KeyEvent and MouseEvent for more info.

Note

If func is a method, this only stores a weak reference to the method. Thus, the figure does not influence the lifetime of the associated object. Usually, you want to make sure that the object is kept alive throughout the lifetime of the figure by holding a reference to it.

Returns:

cid

A connection id that can be used with FigureCanvasBase.mpl_disconnect.

Notes

Note

This is the pyplot wrapper for FigureCanvasBase.mpl_connect.

Examples

def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = canvas.mpl_connect('button_press_event', on_press)

Examples using matplotlib.pyplot.connect#

[]

Mouse move and click events

Mouse move and click events