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(self, event) [source]

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

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

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

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

enable(self, event) [source]

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

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

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

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

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

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

Bases: matplotlib.backend_tools.ToolBase

description = 'Configure subplots'

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(self, *data) [source]

Нарисовать область выделения

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

remove_rubberband(self) [source]

Удалить область выделения

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

trigger(self, 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 = 'Save the figure'

image = 'filesave'

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

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

Bases: matplotlib.backend_tools.ToolBase

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

set_cursor(self, cursor) [source]

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

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

set_figure(self, figure) [source]

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

Параметры:	figureFigure

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

Перемещение назад в стеке ограничений отображения

Bases: 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) [source]

Bases: object

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

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

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

property canvas

default_keymap = None

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

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

description = None

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

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

destroy(self) [source]

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

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

property figure

image = None

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

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

property name

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

set_figure(self, figure) [source]

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

Параметры:	figureFigure

property toolmanager

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

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

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

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

matplotlib.backend_tools.ToolCopyToClipboard

псевдоним matplotlib.backend_tools.ToolCopyToClipboardBase

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

Bases: matplotlib.backend_tools.ToolBase

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

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

description = 'Copy the canvas figure to clipboard'

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

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

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

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

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

Bases: matplotlib.backend_tools.ToolBase

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

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

send_message(self, event) [source]

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

set_figure(self, figure) [source]

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

Параметры:	figureFigure

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

Bases: matplotlib.backend_tools.ToolBase

Инструмент для активации всех осей для взаимодействия с toolmanager

default_keymap = ['a']

description = 'Enable all axes toolmanager'

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

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

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

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

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

Базы: matplotlib.backend_tools.ToolBase

Инструмент для активации конкретной оси для взаимодействия с toolmanager

default_keymap = (1, 2, 3, 4, 5, 6, 7, 8, 9)

description = 'Enable one axes toolmanager'

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

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

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

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

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

Базы: matplotlib.backend_tools.ViewsPositionsBase

Переход к следующему элементу в стеке ограничений просмотра

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

description = 'Forward to next view'

image = 'forward'

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

Базы: matplotlib.backend_tools.ToolToggleBase

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

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

description = 'Toggle fullscreen mode'

disable(self, event) [source]

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

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

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

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

enable(self, event) [source]

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

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

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

Базы: matplotlib.backend_tools._ToolGridBase

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

default_keymap = ['g']

description = 'Toggle major grids'

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

Базы: matplotlib.backend_tools.ToolBase

default_keymap = ['f1']

description = 'Print tool list, shortcuts and description'

static format_shortcut(key_sequence) [source]

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

image = 'help.png'

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

Базы: matplotlib.backend_tools.ViewsPositionsBase

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

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

description = 'Reset original view'

image = 'home'

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

Базы: matplotlib.backend_tools._ToolGridBase

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

default_keymap = ['G']

description = 'Toggle major and minor grids'

class matplotlib.backend_tools.ToolPan(*args) [source]

Базы: 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) [source]

Базы: matplotlib.backend_tools.ToolBase

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

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

description = 'Quit the figure'

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

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

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

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

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

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

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

default_keymap = ['W', 'cmd+W', 'Q']

description = 'Quit all figures'

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

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

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

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

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

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

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

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

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

cursor = None

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

default_toggled = False

Значение по умолчанию для состояния переключения

disable(self, event=None) [source]

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

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

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

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

enable(self, event=None) [source]

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

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

radio_group = None

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

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

set_figure(self, figure) [source]

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

Параметры:	figureFigure

property toggled

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

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

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

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

Bases: matplotlib.backend_tools.ToolBase

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

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

• ToolZoom
• ToolPan
• ToolHome
• ToolBack
• ToolForward

add_figure(self, figure) [source]

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

back(self) [source]

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

clear(self, figure) [source]

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

forward(self) [source]

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

home(self) [source]

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

push_current(self, figure=None) [source]

Добавить текущие пределы представления и положение в соответствующие стеки

refresh_locators(self) [source]

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

update_home_views(self, figure=None) [source]

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

update_view(self) [source]

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

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

Bases: matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['k', 'L']

description = 'Toggle scale X axis'

set_scale(self, ax, scale) [source]

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

Bases: matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['l']

description = 'Toggle scale Y axis'

set_scale(self, ax, scale) [source]

class matplotlib.backend_tools.ToolZoom(*args) [source]

Bases: 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) [source]

Bases: matplotlib.backend_tools.ToolBase

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

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

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

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

Parameters:	eventEvent Событие холста, которое вызвало вызов этого инструмента senderobject Объект, который запросил запуск инструмента dataobject Дополнительные данные

class matplotlib.backend_tools.ZoomPanBase(*args) [source]

Bases: matplotlib.backend_tools.ToolToggleBase

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

disable(self, event) [source]

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

enable(self, event) [source]

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

scroll_zoom(self, event) [source]

trigger(self, 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]

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

Параметры:	containerContainer объект, которому будут добавлены инструменты toolslist, optional Список в формате [[группа1, [инструмент1, инструмент2 ...]], [группа2, [...]]] Где инструменты, заданные инструментом1 и инструментом2, будут отображаться в группе1. Подробнее см. add_tool.

matplotlib.backend_tools.add_tools_to_manager(toolmanager, tools={'home': <class 'matplotlib.backend_tools.ToolHome'>, 'back': <class 'matplotlib.backend_tools.ToolBack'>, 'forward': <class 'matplotlib.backend_tools.ToolForward'>, 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>, 'pan': <class 'matplotlib.backend_tools.ToolPan'>, 'subplots': 'ToolConfigureSubplots', 'save': 'ToolSaveFigure', 'grid': <class 'matplotlib.backend_tools.ToolGrid'>, 'grid_minor': <class 'matplotlib.backend_tools.ToolMinorGrid'>, 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'>, 'quit': <class 'matplotlib.backend_tools.ToolQuit'>, 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'>, 'allnav': <class 'matplotlib.backend_tools.ToolEnableAllNavigation'>, 'nav': <class 'matplotlib.backend_tools.ToolEnableNavigation'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'>, 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'cursor': 'ToolSetCursor', 'rubberband': 'ToolRubberband', 'help': 'ToolHelp', 'copy': 'ToolCopyToClipboard'}) [source]

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

Параметры:	toolmanagerToolManager объект, которому будут добавлены инструменты tools{str: class_like}, optional Инструменты для добавления в виде словаря {имя: инструмент}, см. 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': <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'>}

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