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 the interactive figure. |
Toggle fullscreen. |
|
|
Reset the contents and layout of the drawable Axes. |
|
Timeout for the given number of seconds. During this period it is |
|
Wait for interaction with the interactive figure. Optionally |
|
Draw the figure. |
|
Close the figure. |
|
Get figure object of interactive figure. |
|
Get Axes object of interactive figure. |
Get the last keypress and convert it to lowercase. |
|
Get the last mousepress and convert it to an integer value. |
|
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()
Reset the contents and layout of the drawable Axes.
- 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.
- get_last_keypress()
Get the last keypress and convert it to lowercase.
Returns
- str | None
The last key that was pressed