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='subplots'

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

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

classmatplotlib.backend_tools.Cursors(value, names=None, *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]

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

Bases: ToolBase

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

draw_rubberband(*data)[source]

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

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

remove_rubberband()[source]

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

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

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

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

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

Bases: ToolBase

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

propertydefault_keymap

description='Сохранить фигуру'

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

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

image='filesave'

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

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

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

Bases: ViewsPositionsBase

Возвращение к предыдущим пределам просмотра.

propertydefault_keymap

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

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

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

image='back'

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

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

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

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

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

свойствоcanvas

Поверхность рисунка, на которую влияет этот инструмент, или None.

default_keymap=None

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

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

description=None

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

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

destroy()[source]

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

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

Примечания

Устарело начиная с версии 3.6: Используйте событие tool_removed_event вместо этого.

свойствоfigure

Рисунки, на которые влияет этот инструмент, или None.

image=None

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

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

свойствоname

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

set_figure(figure)[source]

свойствоtoolmanager

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

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

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

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

Параметры:

eventEvent

Событие графического поля, вызвавшее использование инструмента.

senderобъект

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

dataобъект

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

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

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

Базы: ToolBase

свойствоdefault_keymap

description='Копировать рисунок графического поля в буфер обмена'

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

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

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

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

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

Параметры:

eventEvent

Событие графического поля, вызвавшее использование инструмента.

senderобъект

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

dataобъект

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

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

Bases: ToolBase

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

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

send_message(event)[source]

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

set_figure(figure)[source]

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

Bases: ViewsPositionsBase

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

propertydefault_keymap

description='Forward to next view'

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

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

image='forward'

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

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

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

Bases: ToolBase

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

propertydefault_keymap

description='Toggle fullscreen mode'

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

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

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

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

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

Parameters:

eventEvent

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

senderobject

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

dataobject

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

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

Bases: ToolBase

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

propertydefault_keymap

description='Toggle major grids'

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

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

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

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

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

Parameters:

eventEvent

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

senderobject

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

dataobject

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

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

Bases: ToolBase

свойствоdefault_keymap

description='Список инструментов, сочетания клавиш и описания'

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

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

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

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

image='help'

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

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

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

Bases: ViewsPositionsBase

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

свойствоdefault_keymap

description='Сбросить исходный просмотр'

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

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

image='home'

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

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

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

Bases: ToolBase

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

свойствоdefault_keymap

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

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

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

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

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

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

Параметры:

eventEvent

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

senderобъект

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

dataобъект

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

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

Bases: ZoomPanBase

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

cursor=4[source]

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

свойствоdefault_keymap

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

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

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

image='move'

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

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

radio_group='default'

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

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

classmatplotlib.backend_tools.ToolQuit(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.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

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

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

Параметры:

``*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' (взаимоисключающие).

Строка, определяющая группу, или 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]

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

Bases: ZoomPanBase

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

cursor=3[source]

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

propertydefault_keymap

description='Zoom to rectangle'

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

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

image='zoom_to_rect'

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

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

radio_group='default'

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

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

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

Bases: ToolBase

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

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

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

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

Parameters:

eventEvent

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

senderobject

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

dataobject

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

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

Bases: ToolToggleBase

Базовый класс для 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]

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

Parameters:

containerContainer

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

toolslist, optional

Список в формате [[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