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(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]

Bases: matplotlib.backend_tools.ToolBase

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

description = 'Configure subplots'

image = 'subplots'

class matplotlib.backend_tools.Cursors [source]

Bases: object

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

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

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

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

remove_rubberband() [source]

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

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

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

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

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

set_figure(figure) [source]

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

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

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

Bases: matplotlib.backend_tools.ViewsPositionsBase

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

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` ToolManager, который управляет этим инструментом figure: `FigureCanvas` Экземпляр Figure, на который влияет этот инструмент name: Строка Используется в качестве идентификатора инструмента. Должен быть уникальным среди инструментов одного ToolManager

toolmanager: `matplotlib.backend_managers.ToolManager`: 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` Событие Canvas, которое вызвало этот инструмент sender: объект Объект, который запросил запуск инструмента data: объект Дополнительные данные

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

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

Базы: matplotlib.backend_tools.ToolBase

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

description = 'Copy the canvas figure to clipboard'

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

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

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

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

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

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

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

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

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

Базы: matplotlib.backend_tools.ToolBase

default_keymap = ['a']

description = 'Enable all axes toolmanager'

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

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

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

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

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

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

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

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

description = 'Enable one axes toolmanager'

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

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

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

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

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

Основы: 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 = 'Toggle 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 = '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(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

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

Строка, определяющая группу, или 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]

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]: Поместить текущие пределы отображения и позицию в соответствующие стеки

refresh_locators() [source]: Перерисовать холсты, обновить локаторы

update_home_views(figure=None) [source]: Убедиться, что self.home_views содержит запись для всех осей, присутствующих в фигуре

update_view() [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(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(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]

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

Базовый класс для matplotlib.backend_tools.ToolToggleBase

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: Container объект, которому будут добавлены инструменты `tools : list, optional` Список в формате [[группа1, [инструмент1, инструмент2 ...]], [группа2, [...]]] Где инструменты, заданные инструментом1 и инструментом2, будут отображаться в группе1. Подробнее см. `add_tool`

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'>, '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'>}) [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', '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'>}: Инструменты по умолчанию