matplotlib.backend_tools

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

ToolBase

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

ToolToggleBase

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

class matplotlib.backend_tools.AxisScaleBase(*args, **kwargs)

Bases: matplotlib.backend_tools.ToolToggleBase

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

disable(event)

enable(event)

trigger(sender, event, data=None)

class matplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

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

description = 'Configure subplots'

image = 'subplots.png'

class matplotlib.backend_tools.Cursors

Bases: object

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

HAND = 0

MOVE = 3

POINTER = 1

SELECT_REGION = 2

WAIT = 4

class matplotlib.backend_tools.RubberbandBase(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

Рисование и удаление резиновой полосы

draw_rubberband(*data)

Рисование резиновой полосы

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

remove_rubberband()

Удаление резиновой полосы

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

trigger(sender, event, data)

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

class matplotlib.backend_tools.SaveFigureBase(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

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

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

description = 'Save the figure'

image = 'filesave.png'

class matplotlib.backend_tools.SetCursorBase(*args, **kwargs)

Bases: matplotlib.backend_tools.ToolBase

Изменение текущего курсора во время использования inaxes

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

set_cursor(cursor)

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

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

set_figure(figure)

class matplotlib.backend_tools.ToolBack(toolmanager, name)

Bases: matplotlib.backend_tools.ViewsPositionsBase

Перемещение назад в стеке view lim

default_keymap = ['left', 'c', 'backspace']

description = 'Back to previous view'

image = 'back.png'

class matplotlib.backend_tools.ToolBase(toolmanager, name)

Bases: object

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

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

Атрибуты

toolmanager: `matplotlib.backend_managers.ToolManager`	ToolManager, который управляет этим инструментом
figure: `FigureCanvas`	Экземпляр Figure, на который влияет этот инструмент
name: Строка	Используется в качестве идентификатора инструмента, должен быть уникальным среди инструментов одного ToolManager

canvas

default_keymap = None

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

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

description = None

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

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

destroy()

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

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

figure

image = None

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

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

name

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

set_figure(figure)

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

Параметры:	figure: `Figure`

toolmanager

trigger(sender, event, data=None)

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

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

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

class matplotlib.backend_tools.ToolCursorPosition(*args, **kwargs)

Bases: matplotlib.backend_tools.ToolBase

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

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

send_message(event)

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

set_figure(figure)

class matplotlib.backend_tools.ToolEnableAllNavigation(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

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

default_keymap = ['a']

description = 'Enables all axes toolmanager'

trigger(sender, event, data=None)

class matplotlib.backend_tools.ToolEnableNavigation(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

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

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

description = 'Enables one axes toolmanager'

trigger(sender, event, data=None)

class matplotlib.backend_tools.ToolForward(toolmanager, name)

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

default_keymap = ['right', 'v']

description = 'Forward to next view'

image = 'forward.png'

class matplotlib.backend_tools.ToolFullScreen(*args, **kwargs)

Bases: matplotlib.backend_tools.ToolToggleBase

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

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

description = 'Toogle Fullscreen mode'

disable(event)

enable(event)

class matplotlib.backend_tools.ToolGrid(toolmanager, name)

Bases: matplotlib.backend_tools._ToolGridBase

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

default_keymap = ['g']

description = 'Toogle major grids'

class matplotlib.backend_tools.ToolHome(toolmanager, name)

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

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

description = 'Reset original view'

image = 'home.png'

class matplotlib.backend_tools.ToolMinorGrid(toolmanager, name)

Bases: matplotlib.backend_tools._ToolGridBase

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

default_keymap = ['G']

description = 'Toogle major and minor grids'

class matplotlib.backend_tools.ToolPan(*args)

Bases: matplotlib.backend_tools.ZoomPanBase

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

cursor = 3

default_keymap = ['p']

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

image = 'move.png'

radio_group = 'default'

class matplotlib.backend_tools.ToolQuit(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

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

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

description = 'Quit the figure'

trigger(sender, event, data=None)

class matplotlib.backend_tools.ToolQuitAll(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

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

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

description = 'Quit all figures'

trigger(sender, event, data=None)

class matplotlib.backend_tools.ToolToggleBase(*args, **kwargs)

Bases: matplotlib.backend_tools.ToolBase

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

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

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

cursor = None

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

default_toggled = False

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

disable(event=None)

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

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

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

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

enable(event=None)

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

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

radio_group = None

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

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

set_figure(figure)

toggled

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

trigger(sender, event, data=None)

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

class matplotlib.backend_tools.ToolViewsPositions(*args, **kwargs)

Bases: matplotlib.backend_tools.ToolBase

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

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

• ToolZoom
• ToolPan
• ToolHome
• ToolBack
• ToolForward

add_figure(figure)

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

back()

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

clear(figure)

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

forward()

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

home()

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

push_current(figure=None)

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

refresh_locators()

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

update_home_views(figure=None)

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

update_view()

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

class matplotlib.backend_tools.ToolXScale(*args, **kwargs)

Bases: matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['k', 'L']

description = 'Toogle Scale X axis'

set_scale(ax, scale)

class matplotlib.backend_tools.ToolYScale(*args, **kwargs)

Bases: matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['l']

description = 'Toogle Scale Y axis'

set_scale(ax, scale)

class matplotlib.backend_tools.ToolZoom(*args)

Bases: matplotlib.backend_tools.ZoomPanBase

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

cursor = 2

default_keymap = ['o']

description = 'Zoom to rectangle'

image = 'zoom_to_rect.png'

radio_group = 'default'

class matplotlib.backend_tools.ViewsPositionsBase(toolmanager, name)

Bases: matplotlib.backend_tools.ToolBase

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

trigger(sender, event, data=None)

class matplotlib.backend_tools.ZoomPanBase(*args)

Bases: matplotlib.backend_tools.ToolToggleBase

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

disable(event)

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

enable(event)

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

scroll_zoom(event)

trigger(sender, event, data=None)

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

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

Параметры:	container: Container backend_bases.ToolContainerBase объект, которому будут добавлены инструменты tools : список, необязательно Список в форме [[группа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'})

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

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

matplotlib.backend_tools.default_toolbar_tools = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io', ['save']]]

Инструменты по умолчанию в панели инструментов

matplotlib.backend_tools.default_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'}

Инструменты по умолчанию