matplotlib.backend_tools

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

ToolBase

Простой бессостоятельный инструмент

ToolToggleBase

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

classmatplotlib.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.

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

Bases: matplotlib.backend_tools.ToolBase

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

description='Configure subplots'

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

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

image='subplots'

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

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

classmatplotlib.backend_tools.Cursors(value)[source]

Bases: enum.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: matplotlib.backend_tools.ToolBase

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

draw_rubberband(*data)[source]

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

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

remove_rubberband()[source]

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

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

trigger(sender, event, data)[source]

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

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

Bases: matplotlib.backend_tools.ToolBase

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

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

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

list[str]: Список клавиш, которые запустят этот инструмент при нажатии на них в self.figure.canvas.

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

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

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

image='filesave'

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

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

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

Bases: matplotlib.backend_tools.ToolBase

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

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

set_cursor(cursor)[source]

[Устарело] Установка курсора.

Примечания

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

set_figure(figure)[source]

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

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

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

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

list[str]: Список клавиш, которые запустят этот инструмент при нажатии на них в self.figure.canvas.

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.

description=None

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

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

destroy()[source]

Уничтожить инструмент.

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

свойство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.ToolCopyToClipboard[source]

Псевдоним для matplotlib.backend_tools.ToolCopyToClipboardBase

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

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

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

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

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

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

description='Copy the canvas figure to clipboard'

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

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

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

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

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

Параметры

eventEvent

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

senderобъект

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

dataобъект

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

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

Bases: matplotlib.backend_tools.ToolBase

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

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

send_message(event)[source]

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

set_figure(figure)[source]

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

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

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

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

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

description='Forward to next view'

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

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

image='forward'

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

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

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

Bases: matplotlib.backend_tools.ToolToggleBase

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

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

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

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

description='Toggle fullscreen mode'

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

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

disable(event)[source]

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

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

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

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

enable(event)[source]

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

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

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

Bases: matplotlib.backend_tools.ToolBase

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

default_keymap=['g']

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

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

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: matplotlib.backend_tools.ToolBase

default_keymap=['f1']

Ключевая комбинация для ассоциации с этим инструментом.

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

description='Print tool list, shortcuts and description'

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

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

staticformat_shortcut(key_sequence)[source]

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

image='help'

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

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

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

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

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

Ключевая комбинация для ассоциации с этим инструментом.

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

description='Reset original view'

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

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

image='home'

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

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

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

Bases: matplotlib.backend_tools.ToolBase

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

default_keymap=['G']

Ключевая комбинация для ассоциации с этим инструментом.

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

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: matplotlib.backend_tools.ZoomPanBase

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

cursor=4[source]

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

default_keymap=['p']

Ключевая комбинация для ассоциации с этим инструментом.

list[str]: Список клавиш, которые будут активировать этот инструмент при нажатии на self.figure.canvas.

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

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

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

image='move'

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

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

radio_group='default'

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

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

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

Bases: matplotlib.backend_tools.ToolBase

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

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

Сопоставление с этим инструментом.

list[str]: Список клавиш, которые вызовут этот инструмент при нажатии клавиши на self.figure.canvas.

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: matplotlib.backend_tools.ToolBase

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

default_keymap=[]

Сопоставление с этим инструментом.

list[str]: Список клавиш, которые вызовут этот инструмент при нажатии клавиши на self.figure.canvas.

description='Quit all figures'

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

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

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

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

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

Parameters

eventEvent

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

senderobject

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

dataobject

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

matplotlib.backend_tools.ToolSetCursor[source]

alias of matplotlib.backend_tools.SetCursorBase

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

Bases: matplotlib.backend_tools.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

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

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

set_figure(figure)[source]

propertytoggled

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

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

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

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

Bases: 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]

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

update_home_views(figure=None)[source]

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

update_view()[source]

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

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

Bases: matplotlib.backend_tools.AxisScaleBase

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

default_keymap=['k', 'L']

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

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

description='Toggle scale X axis'

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

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

set_scale(ax, scale)[source]

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

Bases: matplotlib.backend_tools.AxisScaleBase

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

default_keymap=['l']

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

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

description='Toggle scale Y axis'

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

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

set_scale(ax, scale)[source]

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

Основа: matplotlib.backend_tools.ZoomPanBase

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

cursor=3[source]

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

default_keymap=['o']

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

list[str]: Список клавиш, которые будут активировать этот инструмент при событии нажатия клавиши на self.figure.canvas.

description='Zoom to rectangle'

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

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

image='zoom_to_rect'

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

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

radio_group='default'

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

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

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

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

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

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

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

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

Параметры

eventEvent

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

senderобъект

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

dataобъект

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

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

Основа: matplotlib.backend_tools.ToolToggleBase

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

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Контейнер

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

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

Список в формате [[group1, [tool1, tool2 ...]], [group2, [...]]], где инструменты [tool1, tool2, ...] будут отображаться в группе group1. См. add_tool для подробностей.

matplotlib.backend_tools.add_tools_to_manager(toolmanager, tools={'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'>, '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.

Parameters

toolmanagerbackend_managers.ToolManager

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

tools{str: class_like}, optional

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

matplotlib.backend_tools.cursors[source]

псевдоним 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={'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'>, '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'>}

Набор инструментов по умолчанию