smpl.plot.connect¶

smpl.plot.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 ~matplotlib.axes.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.

Returns¶

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

Examples¶

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

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