matplotlib.backend_managers

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

基类：object

工具操作（添加/删除）的事件。

class matplotlib.backend_managers.ToolManager(figure=None)

基类：object

管理器，用于在图形上由用户交互（按键、工具栏单击等）触发的操作。

属性:

figure图形

支撑画布的人物。

按键锁定 ： LockDrawLockDraw

LockDraw 对象以了解 canvas 按键事件被锁定。

消息锁 ： LockDrawLockDraw

LockDraw 对象以了解消息是否可供写入。

property active_toggle

当前切换的工具。

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

添加 tool 到 ToolManager .

如果成功，则添加新事件 tool_trigger_{{name}} 在哪里？ {{name}} 是 name 每次触发工具时都会触发事件。

参数:

nameSTR

作为ID处理的工具名称必须是唯一的。

tool类，即str或type

引用以查找要添加的工具的类。

参见

matplotlib.backend_tools.ToolBase

工具的基类。

笔记

args和kwargs直接传递给工具构造函数。

property canvas

画布由FigureManager管理。

property figure

支撑画布的人物。

get_tool(name, warn=True)

返回具有给定名称的工具对象。

为了方便起见，这会传递工具对象。

参数:

name STR或 ToolBasestr或

工具的名称或工具本身。

warnbool，默认值：True

如果不存在具有给定名称的工具，则是否应发出警告。

返回:

ToolBase 或无

如果不存在具有给定名称的工具，则返回“工具”或“无”。

get_tool_keymap(name)

返回与指定工具关联的keymap。

参数:

nameSTR

工具的名称。

返回:

str列表

与工具关联的键的列表。

message_event(message, sender=None)

发出一声 ToolManagerMessageEvent .

remove_tool(name)

删除名为的工具 name .

参数:

nameSTR

工具的名称。

set_figure(figure, update_tools=True)

将给定的图形绑定到工具。

参数:

图形 ： Figure图形

update_toolsbool，默认值：True

强制工具更新图形。

toolmanager_connect(s, func)

用字符串连接事件 s 到 func .

参数:

sSTR

事件的名称。识别以下事件：

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

为添加的每个工具创建一个新事件

• 'toolu triggeru TOOLNAME'，其中TOOLNAME是工具的id。

func可赎回的

具有以下签名的toolmanager事件的回调函数：

def func(event: ToolEvent) -> Any

返回:

CID

连接的回调id。这可以用在 toolmanager_disconnect .

toolmanager_disconnect(cid)

断开回拨ID cid .

示例用法：

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

property tools

dict映射工具名->受控工具。

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

触发工具并发出 tool_trigger_{{name}} 事件。

参数:

nameSTR

工具的名称。

sender对象

希望触发工具的对象。

canvasevent事件

事件原始画布或无。

data对象

触发时要传递到工具的额外数据。

update_keymap(name, key, *args)

将键映射设置为与指定工具关联。

参数:

nameSTR

工具的名称。

keysstr或str列表

与工具关联的键。

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

基类：object

事件携带来自toolmanager的消息。

消息通常通过工具栏显示给用户。

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

基类：matplotlib.backend_managers.ToolEvent

事件通知已触发工具。