`matplotlib.backend_tools`¶

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

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

class matplotlib.backend_tools.AxisScaleBase(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.ToolToggleBase

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

disable(event)[源代码]¶

禁用切换工具。

trigger 当 toggled 是True。

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

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

enable(event)[源代码]¶

启用切换工具。

trigger 当 toggled 是假的。

trigger(sender, event, data=None)[源代码]¶: 调用 enable 或 disable 基于 toggled 价值。

class matplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

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

description = 'Configure subplots'¶

image = 'subplots'¶

class matplotlib.backend_tools.Cursors(value)[源代码]¶

基类：enum.IntEnum

独立于后端的游标类型。

HAND = 0¶

MOVE = 3¶

POINTER = 1¶

SELECT_REGION = 2¶

WAIT = 4¶

class matplotlib.backend_tools.RubberbandBase(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

抽出并取出橡胶带。

draw_rubberband(*data)[源代码]¶

画橡皮筋。

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

remove_rubberband()[源代码]¶

拆下橡胶带。

此方法应在每个后端实现。

trigger(sender, event, data)[源代码]¶: 呼叫 draw_rubberband 或 remove_rubberband 基于数据。

class matplotlib.backend_tools.SaveFigureBase(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

图形保存的基本工具。

default_keymap = ['s', 'ctrl+s']¶

description = 'Save the figure'¶

image = 'filesave'¶

class matplotlib.backend_tools.SetCursorBase(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

更改为当前光标。

这个工具，跟踪所有 ToolToggleBase 派生工具和调用 set_cursor 当工具被触发时。

set_cursor(cursor)[源代码]¶

设置光标。

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

set_figure(figure)[源代码]¶

为工具指定地物。

参数:	图形： `Figure`图形

class matplotlib.backend_tools.ToolBack(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ViewsPositionsBase

向上移动视图限制堆栈。

default_keymap = ['left', 'c', 'backspace', 'MouseButton.BACK']¶

description = 'Back to previous view'¶

image = 'back'¶

class matplotlib.backend_tools.ToolBase(toolmanager, name)[源代码]¶

基类：object

基本工具类。

基础工具，仅工具 trigger 方法或者根本不是方法。该工具由 matplotlib.backend_managers.ToolManager .

属性:	工具管理器： `matplotlib.backend_managers.ToolManagermatplotlib.backend_managers.ToolManager` 控制此工具的工具管理器。图形： `FigureCanvasFigureCanvas` Figure受此工具影响的实例。 `name`STR 工具Id。

property canvas¶

default_keymap = None¶

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

弦：当键按下事件 self.figure.canvas 发射。

description = None¶

工具说明。

弦：如果工具包含在工具栏中，则此文本用作工具提示。

destroy()[源代码]¶

销毁工具。

当工具被 matplotlib.backend_managers.ToolManager.remove_tool .

property figure¶

image = None¶

图像的文件名。

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

property name¶: 工具Id。

set_figure(figure)[源代码]¶

为工具指定地物。

参数:	图形： `Figure`图形

property toolmanager¶

trigger(sender, event, data=None)[源代码]¶

使用此工具时调用。

此方法由调用 matplotlib.backend_managers.ToolManager.trigger_tool .

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

matplotlib.backend_tools.ToolCopyToClipboard¶: alias of matplotlib.backend_tools.ToolCopyToClipboardBase

class matplotlib.backend_tools.ToolCopyToClipboardBase(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

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

default_keymap = ['ctrl+c', 'cmd+c']¶

description = 'Copy the canvas figure to clipboard'¶

trigger(*args, **kwargs)[源代码]¶

使用此工具时调用。

此方法由调用 matplotlib.backend_managers.ToolManager.trigger_tool .

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

class matplotlib.backend_tools.ToolCursorPosition(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

用当前指针位置发送消息。

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

send_message(event)[源代码]¶: 呼叫 matplotlib.backend_managers.ToolManager.message_event .

set_figure(figure)[源代码]¶

为工具指定地物。

参数:	图形： `Figure`图形

class matplotlib.backend_tools.ToolEnableAllNavigation(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools._ToolEnableAllNavigation

[Deprecated]

笔记

3.3 版后已移除:

class matplotlib.backend_tools.ToolEnableNavigation(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools._ToolEnableNavigation

[Deprecated]

笔记

3.3 版后已移除:

class matplotlib.backend_tools.ToolForward(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ViewsPositionsBase

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

default_keymap = ['right', 'v', 'MouseButton.FORWARD']¶

description = 'Forward to next view'¶

image = 'forward'¶

class matplotlib.backend_tools.ToolFullScreen(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.ToolToggleBase

切换全屏的工具。

default_keymap = ['f', 'ctrl+f']¶

description = 'Toggle fullscreen mode'¶

disable(event)[源代码]¶

禁用切换工具。

trigger 当 toggled 是True。

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

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

enable(event)[源代码]¶

启用切换工具。

trigger 当 toggled 是假的。

class matplotlib.backend_tools.ToolGrid(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

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

default_keymap = ['g']¶

description = 'Toggle major grids'¶

trigger(sender, event, data=None)[源代码]¶

使用此工具时调用。

此方法由调用 matplotlib.backend_managers.ToolManager.trigger_tool .

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

class matplotlib.backend_tools.ToolHelpBase(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

default_keymap = ['f1']¶

description = 'Print tool list, shortcuts and description'¶

static format_shortcut(key_sequence)[源代码]¶: 将快捷方式字符串从rc config中使用的表示法转换为显示快捷方式的标准表示法，例如“ctrl+a”->“ctrl+a”。

image = 'help'¶

class matplotlib.backend_tools.ToolHome(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ViewsPositionsBase

恢复原始视图限制。

default_keymap = ['h', 'r', 'home']¶

description = 'Reset original view'¶

image = 'home'¶

class matplotlib.backend_tools.ToolMinorGrid(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

用于切换图形的主栅格和次栅格的工具。

default_keymap = ['G']¶

description = 'Toggle major and minor grids'¶

trigger(sender, event, data=None)[源代码]¶

使用此工具时调用。

此方法由调用 matplotlib.backend_managers.ToolManager.trigger_tool .

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

class matplotlib.backend_tools.ToolPan(*args)[源代码]¶

基类：matplotlib.backend_tools.ZoomPanBase

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

cursor = 3¶

default_keymap = ['p']¶

description = 'Pan axes with left mouse, zoom with right'¶

image = 'move'¶

radio_group = 'default'¶

class matplotlib.backend_tools.ToolQuit(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

工具来调用figure manager destroy方法。

default_keymap = ['ctrl+w', 'cmd+w', 'q']¶

description = 'Quit the figure'¶

trigger(sender, event, data=None)[源代码]¶

使用此工具时调用。

此方法由调用 matplotlib.backend_managers.ToolManager.trigger_tool .

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

class matplotlib.backend_tools.ToolQuitAll(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

工具来调用figure manager destroy方法。

default_keymap = []¶

description = 'Quit all figures'¶

trigger(sender, event, data=None)[源代码]¶

使用此工具时调用。

此方法由调用 matplotlib.backend_managers.ToolManager.trigger_tool .

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

class matplotlib.backend_tools.ToolToggleBase(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

可切换工具。

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

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

cursor = None¶: 激活工具时要使用的光标。

default_toggled = False¶: 切换状态的默认值。

disable(event=None)[源代码]¶

禁用切换工具。

trigger 当 toggled 是True。

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

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

enable(event=None)[源代码]¶

启用切换工具。

trigger 当 toggled 是假的。

radio_group = None¶

属性到“radio”类工具组（互斥）。

弦标识组或 None 如果不属于一个群体。

set_figure(figure)[源代码]¶

为工具指定地物。

参数:	图形： `Figure`图形

property toggled¶: 切换工具的状态。

trigger(sender, event, data=None)[源代码]¶: 调用 enable 或 disable 基于 toggled 价值。

class matplotlib.backend_tools.ToolViewsPositions(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

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

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

ToolZoom
ToolPan
ToolHome
ToolBack
ToolForward

add_figure(figure)[源代码]¶: 将当前地物添加到视图和位置的堆栈中。

back()[源代码]¶: 在视图和位置堆栈中后退一步。

clear(figure)[源代码]¶: 重置轴堆栈。

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

home()[源代码]¶: 从堆栈中调用第一个视图和位置。

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

refresh_locators()[源代码]¶

[Deprecated] 重新绘制画布，更新定位器。

笔记

3.3 版后已移除.

update_home_views(figure=None)[源代码]¶: 确保 self.home_views 具有图形中所有轴的条目。

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

class matplotlib.backend_tools.ToolXScale(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['k', 'L']¶

description = 'Toggle scale X axis'¶

set_scale(ax, scale)[源代码]¶

class matplotlib.backend_tools.ToolYScale(*args, **kwargs)[源代码]¶

基类：matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['l']¶

description = 'Toggle scale Y axis'¶

set_scale(ax, scale)[源代码]¶

class matplotlib.backend_tools.ToolZoom(*args)[源代码]¶

基类：matplotlib.backend_tools.ZoomPanBase

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

cursor = 2¶

default_keymap = ['o']¶

description = 'Zoom to rectangle'¶

image = 'zoom_to_rect'¶

radio_group = 'default'¶

class matplotlib.backend_tools.ViewsPositionsBase(toolmanager, name)[源代码]¶

基类：matplotlib.backend_tools.ToolBase

基类 ToolHome ， ToolBack 和 ToolForward .

trigger(sender, event, data=None)[源代码]¶

使用此工具时调用。

此方法由调用 matplotlib.backend_managers.ToolManager.trigger_tool .

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

class matplotlib.backend_tools.ZoomPanBase(*args)[源代码]¶

基类：matplotlib.backend_tools.ToolToggleBase

基类 ToolZoom 和 ToolPan .

disable(event)[源代码]¶: 释放画布并断开新闻/发布事件的连接。

enable(event)[源代码]¶: 连接新闻/发布事件并锁定画布。

scroll_zoom(event)[源代码]¶

trigger(sender, event, data=None)[源代码]¶: 调用 enable 或 disable 基于 toggled 价值。

matplotlib.backend_tools.add_tools_to_container(container, tools=[['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io', ['save', 'help']]])[源代码]¶

向容器中添加多个工具。

参数:	container集装箱 `backend_bases.ToolContainerBase` 对象来添加工具。 tools可选列表在表单中列出 `[[group1, [tool1, tool2 ...]], [group2, [...]]]` 工具在哪里 `[tool1, tool2, ...]` 将在组1中显示。看到了吗 `add_tool` 有关详细信息。

matplotlib.backend_tools.add_tools_to_manager(toolmanager, tools={'allnav': <class 'matplotlib.backend_tools._ToolEnableAllNavigation'>, 'back': <class 'matplotlib.backend_tools.ToolBack'>, 'copy': 'ToolCopyToClipboard', 'cursor': 'ToolSetCursor', 'forward': <class 'matplotlib.backend_tools.ToolForward'>, 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'>, 'grid': <class 'matplotlib.backend_tools.ToolGrid'>, 'grid_minor': <class 'matplotlib.backend_tools.ToolMinorGrid'>, 'help': 'ToolHelp', 'home': <class 'matplotlib.backend_tools.ToolHome'>, 'nav': <class 'matplotlib.backend_tools._ToolEnableNavigation'>, 'pan': <class 'matplotlib.backend_tools.ToolPan'>, 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'>, 'quit': <class 'matplotlib.backend_tools.ToolQuit'>, 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'>, 'rubberband': 'ToolRubberband', 'save': 'ToolSaveFigure', 'subplots': 'ToolConfigureSubplots', '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.ToolManagerbackend_managers.ToolManager` 添加到管理器的工具。 toolsstr:类，可选要添加到a name:tool dict中的工具，请参见 `add_tool` 更多信息。

matplotlib.backend_tools.cursors¶: alias of matplotlib.backend_tools.Cursors

matplotlib.backend_tools.default_toolbar_tools = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io', ['save', 'help']]]¶: 工具栏中的默认工具

matplotlib.backend_tools.default_tools = {'allnav': <class 'matplotlib.backend_tools._ToolEnableAllNavigation'>, 'back': <class 'matplotlib.backend_tools.ToolBack'>, 'copy': 'ToolCopyToClipboard', 'cursor': 'ToolSetCursor', 'forward': <class 'matplotlib.backend_tools.ToolForward'>, 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'>, 'grid': <class 'matplotlib.backend_tools.ToolGrid'>, 'grid_minor': <class 'matplotlib.backend_tools.ToolMinorGrid'>, 'help': 'ToolHelp', 'home': <class 'matplotlib.backend_tools.ToolHome'>, 'nav': <class 'matplotlib.backend_tools._ToolEnableNavigation'>, 'pan': <class 'matplotlib.backend_tools.ToolPan'>, 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'>, 'quit': <class 'matplotlib.backend_tools.ToolQuit'>, 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'>, 'rubberband': 'ToolRubberband', 'save': 'ToolSaveFigure', 'subplots': 'ToolConfigureSubplots', 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>}¶: 默认工具

matplotlib.backend_tools¶

`matplotlib.backend_tools`¶