matplotlib.backend_tools

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

ToolBase

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

ToolToggleBase

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

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

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

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

Базы: matplotlib.backend_tools.ToolBase

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

description = 'Configure subplots'

image = 'subplots'

class matplotlib.backend_tools.Cursors [source]

Базы: object

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

HAND = 0

MOVE = 3

POINTER = 1

SELECT_REGION = 2

WAIT = 4

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

Базы: matplotlib.backend_tools.ToolBase

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

draw_rubberband(*data) [source]

Нарисовать резиновую ленту

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

remove_rubberband() [source]

Удалить резиновую ленту

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

trigger(sender, event, data) [source]

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

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

Базы: matplotlib.backend_tools.ToolBase

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

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

description = 'Save the figure'

image = 'filesave'

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

Базы: matplotlib.backend_tools.ToolBase

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

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

set_cursor(cursor) [source]

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

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

set_figure(figure) [source]

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

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

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

Базы: matplotlib.backend_tools.ViewsPositionsBase

Перемещение назад по стеку view lim

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

description = 'Back to previous view'

image = 'back'

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

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

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

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

canvas

default_keymap = None

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

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

description = None

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

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

destroy() [source]

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

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

figure

image = None

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

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

name

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

set_figure(figure) [source]

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

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

toolmanager

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

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

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

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

class matplotlib.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]

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

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

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

Bases: matplotlib.backend_tools.ToolBase

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

default_keymap = ['a']

description = 'Enables all axes toolmanager'

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

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

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

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

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

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

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

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

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

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

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

default_keymap = ['right', 'v']

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 = 'Toogle Fullscreen mode'

disable(event) [source]

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

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

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

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

enable(event) [source]

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

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

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

Базы: matplotlib.backend_tools._ToolGridBase

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

default_keymap = ['g']

description = 'Toogle major grids'

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 = 'Toogle 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(sender, event, data=None) [source]

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

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

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

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

Базы: matplotlib.backend_tools.ToolBase

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

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

description = 'Quit all figures'

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

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

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

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

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

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

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

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

set_figure(figure) [source]

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

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

toggled

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

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

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

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

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

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

refresh_locators() [source]

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

update_home_views(figure=None) [source]

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

update_view() [source]

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

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

Базы: matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['k', 'L']

description = 'Toogle Scale X axis'

set_scale(ax, scale) [source]

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

Bases: matplotlib.backend_tools.AxisScaleBase

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

default_keymap = ['l']

description = 'Toogle Scale Y axis'

set_scale(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(sender, event, data=None) [source]

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

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

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

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

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

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

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

matplotlib.backend_tools.add_tools_to_manager(toolmanager, tools={'allnav': <class 'matplotlib.backend_tools.ToolEnableAllNavigation'>, 'back': <class 'matplotlib.backend_tools.ToolBack'>, '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'>, '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'>}) [source]

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

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

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

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

matplotlib.backend_tools.default_tools = {'allnav': <class 'matplotlib.backend_tools.ToolEnableAllNavigation'>, 'back': <class 'matplotlib.backend_tools.ToolBack'>, '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'>, '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'>}

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