matplotlib.widgets.Button

class matplotlib.widgets.Button(ax, label, image=None, color='0.85', hovercolor='0.95', *, useblit=True)

Bases: AxesWidget

A GUI neutral button.

For the button to remain responsive you must keep a reference to it. Call on_clicked to connect to the button.

Attributes:

ax

The Axes the button renders into.

label

A Text instance.

color

The color of the button when not hovering.

hovercolor

The color of the button when hovering.

Parameters:

axAxes

The Axes instance the button will be placed into.

labelstr

The button text.

imagearray-like or PIL Image

The image to place in the button, if not None. The parameter is directly forwarded to imshow.

colorcolor

The color of the button when not activated.

hovercolorcolor

The color of the button when the mouse is over it.

useblitbool, default: True

Use blitting for faster drawing if supported by the backend. See the tutorial Faster rendering by using blitting for details.

Added in version 3.7.

disconnect(cid)

Remove the callback function with connection id cid.

on_clicked(func)

Connect the callback function func to button click events.

Returns a connection id, which can be used to disconnect the callback.

Examples using matplotlib.widgets.Button

Buttons

Buttons

Slider

Slider

Snap sliders to discrete values

Snap sliders to discrete values