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

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

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

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

set_cursor(cursor)

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

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

class matplotlib.backend_tools.ToolBack(toolmanager, name)

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

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: Строка	Используется как Id инструмента, должен быть уникальным среди инструментов одного ToolManager

default_keymap = None

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

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

description = None

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

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

destroy()

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

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

figure

image = None

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

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

name

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

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

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)

Базы: matplotlib.backend_tools.ViewsPositionsBase

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

default_keymap = ['right', 'v']

description = 'Forward to next view'

image = 'forward.png'

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

Базы: matplotlib.backend_tools.ToolToggleBase

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

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

description = 'Toogle Fullscreen mode'

disable(event)

enable(event)

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

Базы: matplotlib.backend_tools.ToolToggleBase

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

default_keymap = ['g']

description = 'Toogle Grid'

disable(event)

enable(event)

trigger(sender, event, data=None)

class matplotlib.backend_tools.ToolHome(toolmanager, name)

Базы: matplotlib.backend_tools.ViewsPositionsBase

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

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

description = 'Reset original view'

image = 'home.png'

class matplotlib.backend_tools.ToolPan(*args)

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

Базы: matplotlib.backend_tools.ToolBase

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

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

description = 'Quit the figure'

trigger(sender, event, data=None)

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

Базы: matplotlib.backend_tools.ToolBase

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

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

cursor = None

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

disable(event=None)

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

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

Это может произойти в разных обстоятельствах

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

enable(event=None)

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

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

radio_group = None

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

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

toggled

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

trigger(sender, event, data=None)

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

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

Базы: matplotlib.backend_tools.ToolBase

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

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

• ToolZoom
• ToolPan
• ToolHome
• ToolBack
• ToolForward

add_figure()

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

back()

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

clear(figure)

Сброс стека осей

forward()

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

home()

Возвращение к первому отображению и позиции из стека

push_current()

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

refresh_locators()

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

update_view()

Обновление viewlim и позиции из стека отображения и позиции для каждой оси

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

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

Базы: matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['l']

description = 'Toogle Scale Y axis'

set_scale(ax, scale)

class matplotlib.backend_tools.ToolZoom(*args)

Базовые классы: 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)

Базовые классы: matplotlib.backend_tools.ToolBase

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

trigger(sender, event, data=None)

class matplotlib.backend_tools.ZoomPanBase(*args)

Базовые классы: 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']], ['layout', ['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={'zoom': , 'fullscreen': , 'rubberband': 'ToolRubberband', 'quit': , 'forward': , 'position': , 'cursor': 'ToolSetCursor', 'viewpos': , 'grid': , 'home': , 'nav': , 'pan': , 'allnav': , 'subplots': 'ToolConfigureSubplots', 'save': 'ToolSaveFigure', 'yscale': , 'xscale': , 'back': })

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

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

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

Стандартные инструменты на панели инструментов

matplotlib.backend_tools.default_tools = {'zoom': , 'fullscreen': , 'rubberband': 'ToolRubberband', 'quit': , 'forward': , 'position': , 'cursor': 'ToolSetCursor', 'viewpos': , 'grid': , 'home': , 'nav': , 'pan': , 'allnav': , 'subplots': 'ToolConfigureSubplots', 'save': 'ToolSaveFigure', 'yscale': , 'xscale': , 'back': }

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