matplotlib.backend_managers

class matplotlib.backend_managers.ToolEvent(name, sender, tool, data=None)

Bases: object

Event for tool manipulation (add/remove).

class matplotlib.backend_managers.ToolManager(figure=None)

Bases: object

Manager for actions triggered by user interactions (key press, toolbar clicks, ...) on a Figure.

Attributes:

figureFigure

Figure that holds the canvas.

keypresslockwidgets.LockDraw

LockDraw object to know if the canvas key_press_event is locked

messagelockwidgets.LockDraw

LockDraw object to know if the message is available to write

property active_toggle

Currently toggled tools.

add_tool(self, name, tool, \*args, \*\*kwargs)

Add tool to ToolManager.

If successful, adds a new event tool_trigger_{name} where {name} is the name of the tool; the event is fired everytime the tool is triggered.

Parameters:

namestr

Name of the tool, treated as the ID, has to be unique.

toolclass_like, i.e. str or type

Reference to find the class of the Tool to added.

See also

matplotlib.backend_tools.ToolBase

The base class for tools.

Notes

args and kwargs get passed directly to the tools constructor.

property canvas

Canvas managed by FigureManager.

property figure

Figure that holds the canvas.

get_tool(self, name, warn=True)

Return the tool object, also accepts the actual tool for convenience.

Parameters:

namestr, ToolBase

Name of the tool, or the tool itself

warnbool, optional

If this method should give warnings.

get_tool_keymap(self, name)

Get the keymap associated with the specified tool.

Parameters:

namestr

Name of the Tool.

Returns:

listlist of keys associated with the Tool

message_event(self, message, sender=None)

Emit a ToolManagerMessageEvent.

remove_tool(self, name)

Remove tool named name.

Parameters:

namestr

Name of the Tool.

set_figure(self, figure, update_tools=True)

Bind the given figure to the tools.

Parameters:

figureFigure

update_toolsbool

Force tools to update figure

toolmanager_connect(self, s, func)

Connect event with string s to func.

Parameters:

sString

Name of the event

The following events are recognized

• 'tool_message_event'
• 'tool_removed_event'
• 'tool_added_event'

For every tool added a new event is created

• 'tool_trigger_TOOLNAME` Where TOOLNAME is the id of the tool.

funcfunction

Function to be called with signature def func(event)

toolmanager_disconnect(self, cid)

Disconnect callback id cid.

Example usage:

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)

property tools

A dict mapping tool name -> controlled tool.

trigger_tool(self, name, sender=None, canvasevent=None, data=None)

Trigger a tool and emit the tool_trigger_{name} event.

Parameters:

namestr

Name of the tool.

senderobject

Object that wishes to trigger the tool

canvaseventEvent

Original Canvas event or None

dataObject

Extra data to pass to the tool when triggering

update_keymap(self, name, \*keys)

Set the keymap to associate with the specified tool.

Parameters:

namestr

Name of the Tool.

keyskeys to associate with the Tool

class matplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message)

Bases: object

Event carrying messages from toolmanager.

Messages usually get displayed to the user by the toolbar.

class matplotlib.backend_managers.ToolTriggerEvent(name, sender, tool, canvasevent=None, data=None)

Bases: matplotlib.backend_managers.ToolEvent

Event to inform that a tool has been triggered.