matplotlib.backend_tools

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

ToolBase

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

ToolToggleBase

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

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

Базы: ToolToggleBase

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

disable(event=None)[source]

Деактивировать инструмент переключения.

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

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

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

enable(event=None)[source]

Активировать инструмент переключения.

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

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

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

classmatplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)[source]

Базы: ToolBase

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

description='Configure subplots'

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

str: Подсказка, используемая, если инструмент включен в панель инструментов.

image='mpl-data/images/subplots'

Имя файла значка.

str | None: Имя файла значка панели инструментов; либо абсолютный, либо относительный к каталогу, содержащему Python-исходный файл, где определён атрибут класса Tool.image (в последнем случае, он не может быть определён как атрибут экземпляра). В любом случае, расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый ими формат значка. Если None, name используется как метка в кнопке панели инструментов.

classmatplotlib.backend_tools.Cursors(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Базы: IntEnum

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

HAND=2[source]

MOVE=4[source]

POINTER=1[source]

RESIZE_HORIZONTAL=6[source]

RESIZE_VERTICAL=7[source]

SELECT_REGION=3[source]

WAIT=5[source]

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

Базы: ToolBase

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

draw_rubberband(*data)[source]

Отрисовка резиновой рамки.

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

remove_rubberband()[source]

Удаление резиновой рамки.

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

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

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

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

Базы: ToolBase

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

свойствоdefault_keymap

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

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

image='mpl-data/images/filesave'

Имя файла иконки.

str | None: Имя файла иконки панели инструментов; абсолютный или относительный путь к каталогу, содержащему исходный файл Python, где определен атрибут класса Tool.image. В последнем случае, атрибут не может быть определен как атрибут экземпляра. В любом случае, расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый формат иконки. Если None, имя используется как метка в кнопке панели инструментов.

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

Базы: ViewsPositionsBase

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

свойствоdefault_keymap

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

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

image='mpl-data/images/back'

Имя файла иконки.

str | None: Имя файла иконки панели инструментов; абсолютный или относительный путь к каталогу, содержащему исходный файл Python, где определен атрибут класса Tool.image. В последнем случае, атрибут не может быть определен как атрибут экземпляра. В любом случае, расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый формат иконки. Если None, имя используется как метка в кнопке панели инструментов.

classmatplotlib.backend_tools.ToolBase(toolmanager, name)[source]

Bases: object

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

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

propertycanvas

Поверхность отображения фигуры, на которую влияет инструмент, или None.

default_keymap=None

Карта клавиш для ассоциации с инструментом.

list[str]: Список клавиш, которые будут вызывать этот инструмент при возникновении события нажатия клавиши на self.figure.canvas. Обратите внимание, что этот атрибут ищется в экземпляре, и поэтому может быть свойством (это используется, например, встроенными инструментами для загрузки rcParams во время создания).

description=None

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

str: Подсказка, используемая, если инструмент включен в панель инструментов.

propertyfigure

Фигура, на которую влияет этот инструмент, или None.

image=None

Имя файла иконки.

str | None: Имя файла иконки панели инструментов; либо абсолютный, либо относительный путь к каталогу, содержащему Python-файл, в котором определен атрибут класса Tool.image (в последнем случае, это не может быть определено как атрибут экземпляра). В любом случае расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать формат иконки по своему усмотрению. Если None, то *name* используется как метка в кнопке панели инструментов.

propertyname

Идентификатор инструмента (строка, должна быть уникальной среди инструментов одного менеджера инструментов).

set_figure(figure)[source]

propertytoolmanager

Менеджер инструментов ToolManager, контролирующий данный инструмент.

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

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

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

Parameters:

eventEvent

Событие на канве, которое вызвало этот инструмент.

senderobject

Объект, запросивший запуск инструмента.

dataobject

Дополнительные данные.

classmatplotlib.backend_tools.ToolCopyToClipboardBase(toolmanager, name)[source]

Bases: ToolBase

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

propertydefault_keymap

description='Copy the canvas figure to clipboard'

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

str: Подсказка, используемая, если инструмент включен в панель инструментов.

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

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

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

Parameters:

eventEvent

Событие на канве, которое вызвало этот инструмент.

senderobject

Объект, запросивший запуск инструмента.

dataobject

Дополнительные данные.

classmatplotlib.backend_tools.ToolCursorPosition(*args, **kwargs)[source]

Bases: ToolBase

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

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

send_message(event)[source]

Вызывает matplotlib.backend_managers.ToolManager.message_event.

set_figure(figure)[source]

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

Базы: ViewsPositionsBase

Переместить вперёд в стеке лимитов отображения.

свойствоdefault_keymap

description='Перейти к следующему представлению'

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

image='mpl-data/images/forward'

Имя файла иконки.

str | None: Имя файла иконки панели инструментов; либо абсолютное, либо относительное к каталогу, содержащему Python-исходный файл, в котором определён атрибут класса Tool.image. В последнем случае, он не может быть определён как атрибут экземпляра. В любом случае, расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый формат иконки. Если None, то *name* используется как метка кнопки на панели инструментов.

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

Базы: ToolBase

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

свойствоdefault_keymap

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

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

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

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

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

Параметры:

eventEvent

Событие холста, которое вызвало этот инструмент.

senderобъект

Объект, запросивший запуск инструмента.

dataобъект

Дополнительные данные.

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

Базы: ToolBase

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

свойствоdefault_keymap

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

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

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

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

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

Параметры:

eventEvent

Событие холста, которое вызвало этот инструмент.

senderобъект

Объект, запросивший запуск инструмента.

dataобъект

Дополнительные данные.

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

Базы: ToolBase

свойствоdefault_keymap

description='Печать списка инструментов, сокращений и описаний'

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

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

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

image='mpl-data/images/help'

Имя файла иконки.

str | None: Имя файла иконки панели инструментов; либо абсолютное, либо относительное к каталогу, содержащему Python-исходный файл, в котором определён атрибут класса Tool.image. В последнем случае, он не может быть определён как атрибут экземпляра. В любом случае, расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый формат иконки. Если None, то *name* используется как метка кнопки на панели инструментов.

classmatplotlib.backend_tools.ToolHome(toolmanager, name)[source]

Bases: ViewsPositionsBase

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

propertydefault_keymap

description='Reset original view'

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

image='mpl-data/images/home'

Имя файла иконки.

str | None: Имя файла иконки для панели инструментов; либо абсолютный, либо относительный путь к каталогу, содержащему файл исходного кода Python, где определён атрибут класса Tool.image. В последнем случае этот атрибут не может быть определён как атрибут экземпляра. В любом случае расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый формат иконки. Если None, то в кнопке на панели инструментов используется имя name в качестве метки.

classmatplotlib.backend_tools.ToolMinorGrid(toolmanager, name)[source]

Bases: ToolBase

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

propertydefault_keymap

description='Toggle major and minor grids'

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

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

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

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

Parameters:

eventEvent

Событие холста, вызвавшее вызов этого инструмента.

senderobject

Объект, запросивший запуск инструмента.

dataobject

Дополнительные данные.

classmatplotlib.backend_tools.ToolPan(*args)[source]

Bases: ZoomPanBase

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

cursor=4[source]

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

propertydefault_keymap

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

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

image='mpl-data/images/move'

Имя файла иконки.

str | None: Имя файла иконки для панели инструментов; либо абсолютный, либо относительный путь к каталогу, содержащему файл исходного кода Python, где определён атрибут класса Tool.image. В последнем случае этот атрибут не может быть определён как атрибут экземпляра. В любом случае расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый формат иконки. Если None, то в кнопке на панели инструментов используется имя name в качестве метки.

radio_group='default'

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

str идентифицирует группу или None, если инструмент не принадлежит к группе.

classmatplotlib.backend_tools.ToolQuit(toolmanager, name)[source]

Bases: ToolBase

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

propertydefault_keymap

description='Quit the figure'

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

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

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

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

Parameters:

eventEvent

Событие холста, вызвавшее вызов этого инструмента.

senderobject

Объект, запросивший запуск инструмента.

dataobject

Дополнительные данные.

classmatplotlib.backend_tools.ToolQuitAll(toolmanager, name)[source]

Bases: ToolBase

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

propertydefault_keymap

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

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

str: Подсказка, используемая, если инструмент включен в панель инструментов.

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

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

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

Parameters:

eventEvent

Событие холста, вызвавшее этот инструмент.

senderobject

Объект, который запросил запуск инструмента.

dataobject

Дополнительные данные.

classmatplotlib.backend_tools.ToolSetCursor(*args, **kwargs)[source]

Bases: ToolBase

Изменение текущего курсора в пределах inaxes.

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

set_figure(figure)[source]

classmatplotlib.backend_tools.ToolToggleBase(*args, **kwargs)[source]

Bases: ToolBase

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

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

Parameters:

``*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

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

str идентифицирует группу или None, если не принадлежит к группе.

set_figure(figure)[source]

propertytoggled

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

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

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

classmatplotlib.backend_tools.ToolViewsPositions(*args, **kwargs)[source]

Bases: ToolBase

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

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

• ToolZoom
• ToolPan
• ToolHome
• ToolBack
• ToolForward

add_figure(figure)[source]

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

back()[source]

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

clear(figure)[source]

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

forward()[source]

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

home()[source]

Восстановить первое представление и положение из стека.

push_current(figure=None)[source]

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

update_home_views(figure=None)[source]

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

update_view()[source]

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

classmatplotlib.backend_tools.ToolXScale(*args, **kwargs)[source]

Bases: AxisScaleBase

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

propertydefault_keymap

description='Toggle scale X axis'

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

str: Подсказка, используемая, если инструмент включен в панель инструментов.

set_scale(ax, scale)[source]

classmatplotlib.backend_tools.ToolYScale(*args, **kwargs)[source]

Bases: AxisScaleBase

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

propertydefault_keymap

description='Toggle scale Y axis'

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

str: Подсказка, используемая, если инструмент включен в панель инструментов.

set_scale(ax, scale)[source]

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

Базовый класс: ZoomPanBase

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

cursor=3[source]

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

свойствоdefault_keymap

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

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

str: Подсказка, используемая, если инструмент включён в панель инструментов.

image='mpl-data/images/zoom_to_rect'

Имя файла иконки.

str | None: Имя файла иконки панели инструментов; либо абсолютный, либо относительный путь к каталогу, содержащему Python-исходник, где определён Tool.image атрибут класса (в последнем случае, он не может быть определён как атрибут экземпляра). В любом случае, расширение необязательно; его отсутствие позволяет отдельным бэкендам выбирать предпочитаемый формат иконки. Если None, то имя используется в качестве метки в кнопке панели инструментов.

radio_group='default'

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

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

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

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

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

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

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

Параметры:

eventEvent

Событие холста, которое вызвало этот инструмент.

senderобъект

Объект, запросивший запуск инструмента.

dataобъект

Дополнительные данные.

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

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

disable(event=None)[source]

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

enable(event=None)[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Контейнер

backend_bases.ToolContainerBase объект, которому будут добавлены инструменты.

toolsсписок, необязательно

Список в формате [[group1, [tool1, tool2 ...]], [group2, [...]]], где инструменты [tool1, tool2, ...] будут отображаться в группе group1. См. 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.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': <class 'matplotlib.backend_tools.ToolHelpBase'>, 'home': <class 'matplotlib.backend_tools.ToolHome'>, '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': <class 'matplotlib.backend_tools.RubberbandBase'>, 'save': <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'>})[source]

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

Параметры:

toolmanagerbackend_managers.ToolManager

Менеджер, которому добавляются инструменты.

tools{str: class_like}, optional

Инструменты для добавления в словаре {имя: инструмент}, см. backend_managers.ToolManager.add_tool для получения дополнительной информации.

matplotlib.backend_tools.cursors[source]

Псевдоним для Cursors