matplotlib.backend_tools

Абстрактные базовые классы определяют примитивы для инструментов. Эти инструменты используются matplotlib.backend_managers.ToolManager

ToolBase

Простой инструмент без состояния

ToolToggleBase

Инструмент, имеющий два состояния, только один инструмент Toggle может быть активным в данный момент для того же matplotlib.backend_managers.ToolManager

class matplotlib.backend_tools.AxisScaleBase(*args, **kwargs)[source]

Bases: matplotlib.backend_tools.ToolToggleBase

Базовый инструмент для переключения между линейным и логарифмическим масштабами.

disable(event)[source]

Отключить инструмент переключения.

trigger вызывает этот метод, когда toggled равно True.

Это может произойти в разных обстоятельствах.

• Нажатие на кнопку инструмента на панели инструментов.
• Вызов matplotlib.backend_managers.ToolManager.trigger_tool.
• Триггер другого инструмента, производного от ToolToggleBase (из того же ToolManager).

enable(event)[source]

Включить инструмент переключения.

trigger вызывает этот метод, когда toggled равно False.

trigger(sender, event, data=None)[source]

Вызывает enable или disable в зависимости от значения toggled.

class matplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)[source]

Bases: matplotlib.backend_tools.ToolBase

Базовый инструмент для конфигурации подграфиков.

description = 'Настроить подграфики'

image = 'subplots'

class matplotlib.backend_tools.Cursors(value)[source]

Bases: enum.IntEnum

Независимые от бэкенда типы курсоров.

HAND = 0

MOVE = 3

POINTER = 1

SELECT_REGION = 2

WAIT = 4

class matplotlib.backend_tools.RubberbandBase(toolmanager, name)[source]

Bases: matplotlib.backend_tools.ToolBase

Рисование и удаление резиновой рамки.

draw_rubberband(*data)[source]

Нарисовать резиновую рамку.

Этот метод должен быть реализован для каждого бэкенда.

remove_rubberband()[source]

Удалить резиновую рамку.

Этот метод должен быть реализован для каждого бэкенда.

trigger(sender, event, data)[source]

Вызывает draw_rubberband или remove_rubberband в зависимости от данных.

class matplotlib.backend_tools.SaveFigureBase(toolmanager, name)[source]

Bases: matplotlib.backend_tools.ToolBase

Базовый инструмент для сохранения рисунка.

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

description = 'Сохранить рисунок'

image = 'filesave'

класс matplotlib.backend_tools.SetCursorBase(*args, **kwargs)[source]

Базы: matplotlib.backend_tools.ToolBase

Изменение текущего курсора во время работы с осями.

Этот инструмент отслеживает все инструменты, производные от ToolToggleBase, и вызывает set_cursor, когда инструмент активируется.

set_cursor(cursor)[source]

Установить курсор.

Этот метод должен быть реализован для каждого бэкэнда.

set_figure(figure)[source]

Присвоить инструменту фигуру.

Параметры:	figureFigure

класс matplotlib.backend_tools.ToolBack(toolmanager, name)[source]

Базы: matplotlib.backend_tools.ViewsPositionsBase

Перемещение назад по стеку пределов отображения.

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

description = 'Возврат к предыдущему представлению'

image = 'back'

класс matplotlib.backend_tools.ToolBase(toolmanager, name)[source]

Базы: object

Базовый класс инструмента.

Базовый инструмент, реализующий только метод trigger или вообще не реализующий его. Инструмент создается matplotlib.backend_managers.ToolManager.

Атрибуты:	toolmanagermatplotlib.backend_managers.ToolManager ToolManager, который управляет этим инструментом. figureFigureCanvas Экземпляр фигуры, на которую влияет этот инструмент. namestr Идентификатор инструмента.

свойство canvas

default_keymap = None

Сопоставление с клавиатурными сокращениями для этого инструмента.

Строка: Список разделённых запятыми клавиш, которые будут использоваться для вызова этого инструмента, когда событие нажатия клавиши self.figure.canvas будет отправлено.

description = None

Описание инструмента.

Строка: Если инструмент включён в панель инструментов, этот текст используется в качестве всплывающей подсказки.

destroy()[source]

Удалить инструмент.

Этот метод вызывается, когда инструмент удаляется методом matplotlib.backend_managers.ToolManager.remove_tool.

свойство figure

image = None

Имя файла изображения.

Строка: Имя файла изображения, которое будет использоваться в панели инструментов. Если None, name используется в качестве метки в кнопке панели инструментов.

свойство name

Идентификатор инструмента.

set_figure(figure)[source]

Присвоить инструменту фигуру.

Параметры:	figureFigure

свойство toolmanager

trigger(sender, event, data=None)[source]

Вызывается, когда этот инструмент используется.

Этот метод вызывается методом matplotlib.backend_managers.ToolManager.trigger_tool.

Параметры:	eventEvent Событие холста, вызвавшее активацию этого инструмента. senderобъект Объект, который запросил активацию инструмента. dataобъект Дополнительные данные.

класс matplotlib.backend_tools.ToolCopyToClipboardBase(toolmanager, name)[source]

Основывается на matplotlib.backend_tools.ToolBase

Инструмент для копирования рисунка в буфер обмена.

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

description = 'Скопировать рисунок холста в буфер обмена'

trigger(*args, **kwargs)[source]

Вызывается при использовании этого инструмента.

Этот метод вызывается matplotlib.backend_managers.ToolManager.trigger_tool.

Параметры:	eventEvent Событие холста, вызвавшее вызов этого инструмента. senderобъект Объект, запросивший запуск инструмента. dataобъект Дополнительные данные.

класс matplotlib.backend_tools.ToolCursorPosition(*args, **kwargs)[source]

Основывается на matplotlib.backend_tools.ToolBase

Отправка сообщения с текущими координатами указателя.

Этот инструмент работает в фоновом режиме, сообщая о позиции курсора.

send_message(event)[source]

Вызов matplotlib.backend_managers.ToolManager.message_event.

set_figure(figure)[source]

Назначение фигуры инструменту.

Параметры:	figureFigure

класс matplotlib.backend_tools.ToolEnableAllNavigation(toolmanager, name)[source]

Основывается на matplotlib.backend_tools._ToolEnableAllNavigation

[Устарело]

Примечания

Устарело начиная с версии 3.3:

класс matplotlib.backend_tools.ToolEnableNavigation(toolmanager, name)[source]

Основывается на matplotlib.backend_tools._ToolEnableNavigation

[Устарело]

Примечания

Устарело начиная с версии 3.3:

класс matplotlib.backend_tools.ToolForward(toolmanager, name)[source]

Основывается на matplotlib.backend_tools.ViewsPositionsBase

Переход вперед в стеке пределов просмотра.

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

description = 'Переход к следующему виду'

image = 'forward'

класс matplotlib.backend_tools.ToolFullScreen(*args, **kwargs)[source]

Основывается на matplotlib.backend_tools.ToolToggleBase

Инструмент для переключения полноэкранного режима.

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

description = 'Переключить полноэкранный режим'

disable(event)[source]

Отключение переключающего инструмента.

trigger вызывается этот метод, когда toggled равно True.

Это может происходить в различных обстоятельствах.

• Нажатие на кнопку инструмента в панели инструментов.
• Вызов matplotlib.backend_managers.ToolManager.trigger_tool.
• Запуск другого инструмента, производного от ToolToggleBase (из того же ToolManager).

enable(event)[source]

Включение переключающего инструмента.

trigger вызывается этот метод, когда toggled равно False.

класс matplotlib.backend_tools.ToolGrid(toolmanager, name)[source]

Базы: matplotlib.backend_tools.ToolBase

Инструмент для переключения основных сетки рисунка.

default_keymap = ['g']

description = 'Переключить основные сетки'

trigger(sender, event, data=None)[source]

Вызывается при использовании этого инструмента.

Этот метод вызывается matplotlib.backend_managers.ToolManager.trigger_tool.

Параметры:	eventEvent Событие холста, вызвавшее этот инструмент. senderобъект Объект, запросивший запуск инструмента. dataобъект Дополнительные данные.

класс matplotlib.backend_tools.ToolHelpBase(toolmanager, name)[source]

Базы: matplotlib.backend_tools.ToolBase

default_keymap = ['f1']

description = 'Вывод списка инструментов, сокращений и описаний'

статический format_shortcut(key_sequence)[source]

Преобразует строку сокращения из обозначения, используемого в конфигурации rc, в стандартное обозначение для отображения сокращений, например, 'ctrl+a' -> 'Ctrl+A'.

image = 'help'

класс matplotlib.backend_tools.ToolHome(toolmanager, name)[source]

Базы: matplotlib.backend_tools.ViewsPositionsBase

Восстановление первоначальных пределов представления.

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

description = 'Сбросить первоначальное представление'

image = 'home'

класс matplotlib.backend_tools.ToolMinorGrid(toolmanager, name)[source]

Базы: matplotlib.backend_tools.ToolBase

Инструмент для переключения основных и вспомогательных сеток рисунка.

default_keymap = ['G']

description = 'Переключить основные и вспомогательные сетки'

trigger(sender, event, data=None)[source]

Вызывается при использовании этого инструмента.

Этот метод вызывается matplotlib.backend_managers.ToolManager.trigger_tool.

Параметры:	eventEvent Событие холста, вызвавшее этот инструмент. senderобъект Объект, запросивший запуск инструмента. dataобъект Дополнительные данные.

класс matplotlib.backend_tools.ToolPan(*args)[source]

Базы: matplotlib.backend_tools.ZoomPanBase

Панорамирование осей левой кнопкой мыши, масштабирование правой.

cursor = 3

default_keymap = ['p']

description = 'Панорамирование осей левой кнопкой мыши, масштабирование правой'

image = 'move'

radio_group = 'default'

class matplotlib.backend_tools.ToolQuit(toolmanager, name)[source]

Bases: matplotlib.backend_tools.ToolBase

Инструмент для вызова метода уничтожения менеджера фигур.

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

description = 'Закрыть фигуру'

trigger(sender, event, data=None)[source]

Вызывается при использовании этого инструмента.

Этот метод вызывается matplotlib.backend_managers.ToolManager.trigger_tool.

Параметры:	eventEvent Событие холста, вызвавшее вызов этого инструмента. senderобъект Объект, запросивший запуск инструмента. dataобъект Дополнительные данные.

class matplotlib.backend_tools.ToolQuitAll(toolmanager, name)[source]

Bases: matplotlib.backend_tools.ToolBase

Инструмент для вызова метода уничтожения менеджера фигур.

default_keymap = []

description = 'Закрыть все фигуры'

trigger(sender, event, data=None)[source]

Вызывается при использовании этого инструмента.

Этот метод вызывается matplotlib.backend_managers.ToolManager.trigger_tool.

Параметры:	eventEvent Событие холста, вызвавшее вызов этого инструмента. senderобъект Объект, запросивший запуск инструмента. dataобъект Дополнительные данные.

класс matplotlib.backend_tools.ToolToggleBase(*args, **kwargs)[source]

Базовый класс для переключаемых инструментов.

Каждый раз при срабатывании переключает состояние между включением и выключением.

Параметры:	``*args`` Переменное количество аргументов, используемых инструментом. ``**kwargs`` toggled, если присутствует и True, устанавливает начальное состояние инструмента. Произвольные именованные аргументы для инструмента.

cursor = None

Курсор, используемый при активном инструменте.

default_toggled = False

Значение по умолчанию для состояния включения/выключения.

disable(event=None)[source]

Выключает переключаемый инструмент.

trigger вызывает этот метод, когда toggled равно True.

Это может происходить в разных ситуациях.

• Нажатие на кнопку инструмента в панели инструментов.
• Вызов matplotlib.backend_managers.ToolManager.trigger_tool.
• Срабатывание другого инструмента, производного от ToolToggleBase (из того же менеджера инструментов ToolManager).

enable(event=None)[source]

Включает переключаемый инструмент.

trigger вызывает этот метод, когда toggled равно False.

radio_group = None

Атрибут для группировки инструментов типа «радиокнопки» (взаимоисключающие).

Строка, идентифицирующая группу, или None, если инструмент не принадлежит к группе.

set_figure(figure)[source]

Назначает фигуру инструменту.

Параметры:	figureFigure

свойство toggled

Состояние переключаемого инструмента.

trigger(sender, event, data=None)[source]

Вызывает enable или disable в зависимости от значения toggled.

класс matplotlib.backend_tools.ToolViewsPositions(*args, **kwargs)[source]

Базы: matplotlib.backend_tools.ToolBase

Вспомогательный инструмент для обработки изменений представлений и позиций.

Работает в фоновом режиме и должен использоваться всеми инструментами, которым необходимо получить доступ к истории представлений и позиций фигуры, например:

• ToolZoom
• ToolPan
• ToolHome
• ToolBack
• ToolForward

add_figure(figure)[source]

Добавить текущую фигуру в стек представлений и позиций.

back()[source]

Назад на один шаг в стеке представлений и позиций.

clear(figure)[source]

Сбросить стек осей.

forward()[source]

Вперед на один шаг в стеке представлений и позиций.

home()[source]

Вернуться к первому представлению и позиции из стека.

push_current(figure=None)[source]

Поместить текущие пределы представления и позицию в соответствующие стеки.

refresh_locators()[source]

[Устарело] Перерисовать холсты, обновить локали.

Замечания

Устарело начиная с версии 3.3.

update_home_views(figure=None)[source]

Убедиться, что self.home_views имеет запись для всех осей, присутствующих в фигуре.

update_view()[source]

Обновить пределы представления и позицию для каждой оси из текущей позиции стека. Если в фигуре присутствуют какие-либо оси, которых нет в текущей позиции стека, использовать для этих осей пределы представления по умолчанию и не обновлять никакие позиции.

класс matplotlib.backend_tools.ToolXScale(*args, **kwargs)[source]

Базы: matplotlib.backend_tools.AxisScaleBase

Инструмент для переключения между линейными и логарифмическими масштабами по оси X.

default_keymap = ['k', 'L']

description = 'Переключить масштаб оси X'

set_scale(ax, scale)[source]

класс matplotlib.backend_tools.ToolYScale(*args, **kwargs)[source]

Базы: matplotlib.backend_tools.AxisScaleBase

Инструмент для переключения между линейными и логарифмическими масштабами по оси Y.

default_keymap = ['l']

description = 'Переключить масштаб оси Y'

set_scale(ax, scale)[source]

класс matplotlib.backend_tools.ToolZoom(*args)[source]

Базы: matplotlib.backend_tools.ZoomPanBase

Инструмент для масштабирования с помощью селектора прямоугольника.

cursor = 2

default_keymap = ['o']

description = 'Масштабировать до прямоугольника'

image = 'zoom_to_rect'

radio_group = 'default'

класс matplotlib.backend_tools.ViewsPositionsBase(toolmanager, name)[source]

Базовый класс для ToolHome, ToolBack и ToolForward.

Основан на matplotlib.backend_tools.ToolBase.

trigger(sender, event, data=None)[source]

Вызывается при использовании данного инструмента.

Этот метод вызывается методом matplotlib.backend_managers.ToolManager.trigger_tool.

Параметры:	eventEvent Событие холста, которое вызвало запуск этого инструмента. senderобъект Объект, запросивший запуск инструмента. dataобъект Дополнительные данные.

класс matplotlib.backend_tools.ZoomPanBase(*args)[source]

Базовый класс для ToolZoom и ToolPan.

Наследуется от matplotlib.backend_tools.ToolToggleBase.

disable(event)[source]

Отпускает холст и отключает события нажатия/отпускания.

enable(event)[source]

Подключает события нажатия/отпускания и блокирует холст.

scroll_zoom(event)[source]

trigger(sender, event, data=None)[source]

Вызывает enable или disable в зависимости от значения toggled.

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

Добавляет несколько инструментов в контейнер.

Параметры:	containerКонтейнер Объект, которому будут добавлены инструменты. toolsсписок, необязательно Список в формате [[group1, [tool1, tool2 ...]], [group2, [...]]], где инструменты [tool1, tool2, ...] будут отображаться в группе group1. Подробнее см. 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'>})[source]

Добавляет несколько инструментов в менеджер ToolManager.

Параметры:	toolmanagerbackend_managers.ToolManager Менеджер, которому добавляются инструменты. tools{строка: класс_подобный}, необязательно Инструменты для добавления в виде словаря {имя: инструмент}, см. add_tool для получения дополнительной информации.

matplotlib.backend_tools.cursors

Псевдоним 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': , 'back': , 'copy': 'ToolCopyToClipboard', 'cursor': 'ToolSetCursor', 'forward': , 'fullscreen': , 'grid': , 'grid_minor': , 'help': 'ToolHelp', 'home': , 'nav': , 'pan': , 'position': , 'quit': , 'quit_all': , 'rubberband': 'ToolRubberband', 'save': 'ToolSaveFigure', 'subplots': 'ToolConfigureSubplots', 'viewpos': , 'xscale': , 'yscale': , 'zoom': }

Стандартные инструменты