`matplotlib.backend_tools`#

抽象基类定义了工具的原语。这些工具由matplotlib.backend_managers.ToolManager

ToolBase: 简单的无状态工具
ToolToggleBase: 具有两种状态的工具，在任何给定时间只能激活一个切换工具 matplotlib.backend_managers.ToolManager

类 matplotlib.backend_tools。AxisScaleBase ( * args , ** kwargs ) [来源] #

基地：ToolToggleBase

在线性和对数之间切换的基本工具。

禁用（事件=无）[来源] #

禁用切换工具。

triggertoggled为 True时调用此方法。

这可能发生在不同的情况下。

单击工具栏工具按钮。
打电话给matplotlib.backend_managers.ToolManager.trigger_tool。
另一个ToolToggleBase派生工具被触发（来自同一个ToolManager）。

启用（事件=无）[来源] #

启用切换工具。

triggertoggled为 False时调用此方法。

触发器（发件人，事件，数据=无）[来源] #: 调用enable或disable基于toggled价值。

类 matplotlib.backend_tools。ConfigureSubplotsBase ( toolmanager , name ) [source] #

基地：ToolBase

用于配置子图的基本工具。

description = '配置子图' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

图像= '子图' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

类 matplotlib.backend_tools。游标（值）[来源] #

基地：IntEnum

与后端无关的游标类型。

HAND = 2 [来源] #

MOVE = 4 [来源] #

指针= 1 [来源] #

RESIZE_HORIZONTAL = 6 [来源] #

RESIZE_VERTICAL = 7 [来源] #

SELECT_REGION = 3 [来源] #

等待= 5 [来源] #

类 matplotlib.backend_tools。RubberbandBase ( toolmanager , name ) [来源] #

基地：ToolBase

画并取下橡皮筋。

draw_rubberband ( * data ) [来源] #

画橡皮筋。

此方法必须在每个后端实现。

remove_rubberband ( ) [来源] #

取下橡皮筋。

这个方法应该在每个后端实现。

触发器（发件人，事件，数据=无）[来源] #: 调用draw_rubberband或remove_rubberband基于数据。

类 matplotlib.backend_tools。SaveFigureBase ( toolmanager , name ) [source] #

基地：ToolBase

图形保存的基本工具。

属性 default_keymap #

description = '保存图' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

图像= '文件保存' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

类 matplotlib.backend_tools。SetCursorBase ( * args , ** kwargs ) [来源] #

基地：ToolBase

inaxes 时更改为当前光标。

该工具跟踪所有ToolToggleBase派生工具，并 set_cursor在工具被触发时调用。

set_cursor ( cursor ) [源代码] #

[弃用] 设置光标。

笔记

3.5 版后已弃用：改为使用FigureCanvasBase.set_cursor。

set_figure (图) [来源] #

类 matplotlib.backend_tools。ToolBack ( toolmanager , name ) [source] #

基地：ViewsPositionsBase

向后移动视图限制堆栈。

属性 default_keymap #

description = '返回上一视图' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

图像= '返回' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

类 matplotlib.backend_tools。ToolBase ( toolmanager , name ) [来源] #

基地：object

基础工具类。

一个基础工具，只实现trigger方法或根本不实现方法。该工具由matplotlib.backend_managers.ToolManager.

属性画布#: 受此工具影响的图形的画布，或无。

default_keymap =无#

与此工具关联的键盘映射。

list[str]：在上发出按键事件时将触发此工具的键列表self.figure.canvas。请注意，此属性是在实例上查找的，因此可以是一个属性（例如，内置工具使用它在实例化时加载 rcParams）。

描述=无#

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

销毁( ) [来源] #

[已弃用] 销毁工具。

此方法由调用ToolManager.remove_tool。

笔记

3.6 版后已弃用：改用 tool_removed_event。

属性图#: 受此工具影响的图形，或无。

图片=无#

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

属性名称#: 工具 id（str，在工具管理器的工具中必须是唯一的）。

set_figure (图) [来源] #

属性工具管理器#: ToolManager控制这个工具的那个。

触发器（发件人，事件，数据=无）[来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

类 matplotlib.backend_tools。ToolCopyToClipboardBase ( toolmanager , name ) [source] #

基地：ToolBase

将图形复制到剪贴板的工具。

属性 default_keymap #

description = '将画布图复制到剪贴板' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

触发器( * args , ** kwargs ) [来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

类 matplotlib.backend_tools。ToolCursorPosition ( * args , ** kwargs ) [来源] #

基地：ToolBase

发送带有当前指针位置的消息。

该工具在后台运行，报告光标的位置。

send_message (事件) [来源] #: 打电话matplotlib.backend_managers.ToolManager.message_event。

set_figure (图) [来源] #

类 matplotlib.backend_tools。ToolForward ( toolmanager , name ) [来源] #

基地：ViewsPositionsBase

在视图 lim 堆栈中向前移动。

属性 default_keymap #

description = '前进到下一个视图' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

图像= '前进' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

类 matplotlib.backend_tools。ToolFullScreen ( toolmanager , name ) [source] #

基地：ToolBase

切换全屏的工具。

属性 default_keymap #

description = '切换全屏模式' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

触发器（发件人，事件，数据=无）[来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

类 matplotlib.backend_tools。ToolGrid ( toolmanager , name ) [来源] #

基地：ToolBase

用于切换图形主要网格的工具。

属性 default_keymap #

description = '切换主要网格' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

触发器（发件人，事件，数据=无）[来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

类 matplotlib.backend_tools。ToolHelpBase ( toolmanager , name ) [source] #

基地：ToolBase

属性 default_keymap #

description = '打印工具列表、快捷方式和描述' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

静态 format_shortcut ( key_sequence ) [source] #: 将快捷方式字符串从 rc config 中使用的符号转换为用于显示快捷方式的标准符号，例如 'ctrl+a' -> 'Ctrl+A'。

图片= '帮助' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

类 matplotlib.backend_tools。ToolHome ( toolmanager , name ) [来源] #

基地：ViewsPositionsBase

恢复原始视图限制。

属性 default_keymap #

description = '重置原始视图' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

图片= '家' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

类 matplotlib.backend_tools。ToolMinorGrid ( toolmanager , name ) [source] #

基地：ToolBase

切换图形的主要和次要网格的工具。

属性 default_keymap #

description = '切换主要和次要网格' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

触发器（发件人，事件，数据=无）[来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

类 matplotlib.backend_tools。ToolPan ( * args ) [来源] #

基地：ZoomPanBase

用鼠标左键平移轴，用鼠标右键缩放。

光标= 4 [来源] #: 工具激活时使用的光标。

属性 default_keymap #

description = '用鼠标左键平移轴，用右键缩放' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

图像= '移动' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

radio_group = '默认' #

对类似工具的“无线电”进行分组的属性（互斥）。

str如果不属于某个组，则标识组或None 。

类 matplotlib.backend_tools。ToolQuit ( toolmanager , name ) [source] #

基地：ToolBase

调用图形管理器销毁方法的工具。

属性 default_keymap #

description = '退出图' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

触发器（发件人，事件，数据=无）[来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

类 matplotlib.backend_tools。ToolQuitAll ( toolmanager , name ) [source] #

基地：ToolBase

调用图形管理器销毁方法的工具。

属性 default_keymap #

description = '退出所有人物' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

触发器（发件人，事件，数据=无）[来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

matplotlib.backend_tools。ToolSetCursor [来源] #: 的别名SetCursorBase

类 matplotlib.backend_tools。ToolToggleBase ( * args , ** kwargs ) [来源] #

基地：ToolBase

可切换工具。

每次触发时，它都会在启用和禁用之间切换。

参数：

``*参数``: 工具使用的可变长度参数。
``**kwargs``: toggled如果存在且为真，则设置工具任意关键字参数的初始状态以供工具使用

光标=无#: 工具激活时使用的光标。

default_toggled =假#: 切换状态的默认值。

禁用（事件=无）[来源] #

禁用切换工具。

triggertoggled为 True时调用此方法。

这可能发生在不同的情况下。

单击工具栏工具按钮。
打电话给matplotlib.backend_managers.ToolManager.trigger_tool。
另一个ToolToggleBase派生工具被触发（来自同一个ToolManager）。

启用（事件=无）[来源] #

启用切换工具。

triggertoggled为 False时调用此方法。

radio_group =无#

对类似工具的“无线电”进行分组的属性（互斥）。

str如果不属于某个组，则标识组或None 。

set_figure (图) [来源] #

属性切换#: 切换工具的状态。

触发器（发件人，事件，数据=无）[来源] #: 调用enable或disable基于toggled价值。

类 matplotlib.backend_tools。ToolViewsPositions ( * args , ** kwargs ) [来源] #

基地：ToolBase

处理视图和位置变化的辅助工具。

在后台运行并且应该被所有需要访问图形的视图和位置历史的工具使用，例如

ToolZoom
ToolPan
ToolHome
ToolBack
ToolForward

add_figure (图) [来源] #: 将当前图形添加到视图和位置堆栈。

返回( ) [来源] #: 在视图和位置堆栈中退一步。

清晰（图）[来源] #: 重置坐标区堆栈。

forward ( ) [来源] #: 在视图和位置堆栈中前进一步。

主页( ) [来源] #: 从堆栈中调用第一个视图和位置。

push_current ( figure = None ) [来源] #: 将当前视图限制和位置推送到各自的堆栈上。

update_home_views (图=无) [来源] #: 确保self.home_views图中存在所有轴的条目。

update_view ( ) [来源] #: 从当前堆栈位置更新每个轴的视图限制和位置。如果图中存在不在当前堆栈位置的任何轴，请使用这些轴的主视图限制并且不要更新任何位置。

类 matplotlib.backend_tools。ToolXScale ( * args , ** kwargs ) [来源] #

基地：AxisScaleBase

用于在 X 轴上的线性和对数刻度之间切换的工具。

属性 default_keymap #

description = '切换缩放X轴' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

set_scale ( ax , scale ) [来源] #

类 matplotlib.backend_tools。ToolYScale ( * args , ** kwargs ) [来源] #

基地：AxisScaleBase

在 Y 轴上的线性和对数刻度之间切换的工具。

属性 default_keymap #

description = '切换缩放Y轴' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

set_scale ( ax , scale ) [来源] #

类 matplotlib.backend_tools。ToolZoom ( * args ) [来源] #

基地：ZoomPanBase

使用矩形选择器进行缩放的工具。

光标= 3 [来源] #: 工具激活时使用的光标。

属性 default_keymap #

description = '缩放到矩形' #

工具说明。

str：如果工具包含在工具栏中，则使用工具提示。

图像= 'zoom_to_rect' #

图像的文件名。

str：要在工具栏中使用的图像的文件名。如果没有，该名称将用作工具栏按钮中的标签。

radio_group = '默认' #

对类似工具的“无线电”进行分组的属性（互斥）。

str如果不属于某个组，则标识组或None 。

类 matplotlib.backend_tools。ViewsPositionsBase ( toolmanager , name ) [source] #

基地：ToolBase

和的ToolHome基类。ToolBackToolForward

触发器（发件人，事件，数据=无）[来源] #

使用此工具时调用。

此方法由调用ToolManager.trigger_tool。

参数：

事件Event: 导致调用此工具的画布事件。
发件人对象: 请求触发工具的对象。
数据对象: 额外数据。

类 matplotlib.backend_tools。ZoomPanBase ( * args ) [来源] #

基地：ToolToggleBase

ToolZoom和的基类ToolPan。

禁用（事件=无）[来源] #: 释放画布并断开新闻/发布事件。

启用（事件=无）[来源] #: 连接新闻/发布事件并锁定画布。

scroll_zoom (事件) [来源] #

触发器（发件人，事件，数据=无）[来源] #: 调用enable或disable基于toggled价值。

matplotlib.backend_tools。add_tools_to_container (容器, tools = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io ', ['保存', '帮助']]] ) [来源] #

向容器中添加多个工具。

参数：

集装箱集装箱: backend_bases.ToolContainerBase将添加工具的对象。
工具列表，可选: 以工具将在 group1 中显示的形式列出。详情请参阅。[[group1, [tool1, tool2 ...]], [group2, [...]]][tool1, tool2, ...]backend_bases.ToolContainerBase.add_tool

matplotlib.backend_tools。add_tools_to_manager ( toolmanager , tools={'back': <class 'matplotlib.backend_tools.ToolBack'> , 'copy': <class 'matplotlib.backend_tools.ToolCopyToClipboardBase'> , 'cursor': <class 'matplotlib.backend_tools.SetCursorBase' > , 'forward': <class 'matplotlib.backend_tools.ToolForward'> , 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'> , 'grid': <class 'matplotlib.backend_tools.ToolGrid' 'matplotlib.backend_tools.ToolMinorGrid'> , 'help': <class 'matplotlib.backend_tools.ToolHelpBase'> , 'home': <class 'matplotlib.backend_tools.ToolHome'> , 'pan': <class 'matplotlib.backend_tools. ToolPan'>， “位置”： <class 'matplotlib.backend_tools.ToolCursorPosition'>， 'quit'： <class 'matplotlib.backend_tools.ToolQuit'>， 'quit_all'： <class 'matplotlib.backend_tools.ToolQuitAll'>， '橡皮筋'： <class 'matplotlib.backend_tools.RubberbandBase'>， '保存'： <class 'matplotlib.backend_tools.SaveFigureBase' > , 'subplots' : < class ' matplotlib.backend_tools.ConfigureSubplotsBase'> , 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'> , 'xscale': <class 'matplotlib. backend_tools.ToolXScale'> , 'yscale': <class 'matplotlib.backend_tools.ToolYScale'> , 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>} ) [来源] #

将多个工具添加到ToolManager.

参数：

工具管理器backend_managers.ToolManager: 添加工具的管理器。
工具{str: class_like}，可选: 在 {name: tool} 字典中添加的工具，请参阅 backend_managers.ToolManager.add_tool更多信息。

matplotlib.backend_tools。游标[来源] #: 的别名Cursors

matplotlib.backend_tools#

`matplotlib.backend_tools`#