You are reading an old version of the documentation (v2.1.1). For the latest version see https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.ginput.html
matplotlib
Fork me on GitHub


Travis-CI:

Table Of Contents

This Page

matplotlib.pyplot.ginput

matplotlib.pyplot.ginput(*args, **kwargs)

Blocking call to interact with a figure.

Wait until the user clicks n times on the figure, and return the coordinates of each click in a list.

The buttons used for the various actions (adding points, removing points, terminating the inputs) can be overridden via the arguments mouse_add, mouse_pop and mouse_stop, that give the associated mouse button: 1 for left, 2 for middle, 3 for right.

Parameters:

n : int, optional, default: 1

Number of mouse clicks to accumulate. If negative, accumulate clicks until the input is terminated manually.

timeout : scalar, optional, default: 30

Number of seconds to wait before timing out. If zero or negative will never timeout.

show_clicks : bool, optional, default: False

If True, show a red cross at the location of each click.

mouse_add : int, one of (1, 2, 3), optional, default: 1 (left click)

Mouse button used to add points.

mouse_pop : int, one of (1, 2, 3), optional, default: 3 (right click)

Mouse button used to remove the most recently added point.

mouse_stop : int, one of (1, 2, 3), optional, default: 2 (middle click)

Mouse button used to stop input.

Returns:

points : list of tuples

A list of the clicked (x, y) coordinates.

Notes

The keyboard can also be used to select points in case your mouse does not have one or more of the buttons. The delete and backspace keys act like right clicking (i.e., remove last point), the enter key terminates input and any other key (not already used by the window manager) selects a point.

Examples using matplotlib.pyplot.ginput