matplotlib.backend_managers#

matplotlib.backend_managers。ToolEvent ( name , sender , tool , data = None ) [source] #

基地:object

工具操作事件(添加/删除)。

matplotlib.backend_managers。ToolManager (=) [来源] #

基地:object

由图形上的用户交互(按键、工具栏单击等)触发的操作的管理器。

属性
figureFigure

拿着画布的图。

按键锁LockDraw

LockDraw对象以了解canvaskey_press_event 是否被锁定。

消息锁LockDraw

LockDraw对象以知道消息是否可以写入。

属性 active_toggle #

当前切换工具。

add_tool ( name , tool , * args , ** kwargs ) [source] #

工具添加到ToolManager.

如果成功,则添加一个新事件tool_trigger_{name},其中 工具{name}名称是;每次触发该工具时都会触发该事件。

参数
名称str

被视为 ID 的工具名称必须是唯一的。

工具类型

要添加的工具的类。如果为当前画布类注册了一个子类,则将使用一个子类。

也可以看看

matplotlib.backend_tools.ToolBase

工具的基类。

笔记

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

属性 画布#

由 FigureManager 管理的画布。

属性 #

拿着画布的图。

get_tool ( name , warn = True ) [source] #

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

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

参数
名称str 或ToolBase

工具的名称,或工具本身。

警告布尔值,默认值:True

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

返回
ToolBase或无

如果不存在具有给定名称的工具,则为工具或无。

get_tool_keymap (名称) [来源] #

返回与指定工具关联的键盘映射。

参数
名称str

工具的名称。

返回
str 列表

与工具关联的键列表。

message_event ( message , sender = None ) [来源] #

发出一个ToolManagerMessageEvent.

remove_tool (名称) [来源] #

删除名为name的工具。

参数
名称str

工具的名称。

set_figure (, update_tools = True ) [来源] #

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

参数
数字Figure
update_tools布尔值,默认值:True

强制工具更新图形。

toolmanager_connect ( s , func ) [来源] #

将带有字符串s 的事件连接到func

参数
字符串_

事件的名称。识别出以下事件:

  • '工具_消息_事件'

  • 'tool_removed_event'

  • “工具添加事件”

对于添加的每个工具,都会创建一个新事件

  • 'tool_trigger_TOOLNAME',其中 TOOLNAME 是工具的 ID。

函数可调用

带有签名的工具管理器事件的回调函数:

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)
属性 工具#

字典映射工具名称 -> 受控工具。

trigger_tool ( name , sender = None , canvasevent = None , data = None ) [source] #

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

参数
名称str

工具的名称。

发件人对象

希望触发工具的对象。

canvasevent事件

原始画布事件或无。

数据对象

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

update_keymap ( name , key ) [来源] #

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

参数
名称str

工具的名称。

str 或 str 列表

与工具关联的键。

matplotlib.backend_managers。ToolManagerMessageEvent ( name , sender , message ) [source] #

基地:object

携带来自工具管理器的消息的事件。

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

matplotlib.backend_managers。ToolTriggerEvent ( name , sender , tool , canvasevent = None , data = None ) [source] #

基地:ToolEvent

通知工具已被触发的事件。