interactive_figure.interactive_figure

This module provides functions to create and interact with a Matplotlib figure.

The figure registers mouse presses, keyboard input and the location of the mouse after any input. The user has fine-grained control over when to wait for input and when to draw the contents of the figure.

Source: https://github.com/teuncm/interactive-figure

Module Contents

Functions

create([aspect_ratio, hide_toolbar])

Create the interactive figure.

toggle_fullscreen()

Toggle fullscreen.

clear([hide_labels, set_limits])

Reset contents and layout of the figure. set_limits will set the Axes limits to

wait(timeout)

Timeout for the given number of seconds. During this period it is

wait_for_interaction([timeout])

Wait for interaction with the interactive figure. Optionally

draw()

Draw the figure.

close()

Close the figure.

gcf()

Get figure object of interactive figure.

gca()

Get Axes object of interactive figure.

get_last_key_press()

Get the last keypress and convert it to lowercase.

get_last_mouse_press()

Get the last mousepress and convert it to an integer value.

get_last_mouse_pos()

Get the last mouse position.

create(aspect_ratio='auto', hide_toolbar=False, **kwargs)

Create the interactive figure.

Parameters

aspect_ratiostr, optional

aspect ratio of the Axes, by default “auto”

hide_toolbarbool, optional

whether to hide the toolbar, by default False

remaining arguments will be sent to the figure upon creation

Raises

RuntimeError

if multiple interactive figures are created.

toggle_fullscreen()

Toggle fullscreen.

clear(hide_labels=False, set_limits=True)

Reset contents and layout of the figure. set_limits will set the Axes limits to [0, 100]. hide_labels will remove all labels.

wait(timeout)

Timeout for the given number of seconds. During this period it is not possible to interact with the figure. For sub-second timeouts use time.wait() instead.

Parameters

timeoutfloat

Number of seconds to wait for

wait_for_interaction(timeout=-1)

Wait for interaction with the interactive figure. Optionally use a timeout in seconds.

Parameters

timeoutint, optional

Timeout in seconds when waiting for input.

Returns

bool | None
  • True if a key was pressed.

  • False if a mouse button was pressed.

  • None if no input was given within the timeout.

draw()

Draw the figure.

close()

Close the figure.

gcf()

Get figure object of interactive figure.

Returns

Figure handler

gca()

Get Axes object of interactive figure.

Returns

Axes handler

get_last_key_press()

Get the last keypress and convert it to lowercase.

Returns

str | None

The last key that was pressed

get_last_mouse_press()

Get the last mousepress and convert it to an integer value.

Returns

int | None

The identifier of the last mouse button that was pressed

get_last_mouse_pos()

Get the last mouse position.

Returns

(x: float, y: float) | (None, None)

The last registered mouse position after any interaction