matplotlib.backend_managers

class matplotlib.backend_managers.ToolEvent(name, sender, tool, data=None)[source]

Событие для управления инструментом (добавление/удаление).

class matplotlib.backend_managers.ToolManager(figure=None)[source]

Основы: object

Менеджер для действий, вызываемых взаимодействием пользователя (нажатие клавиши, щелчки в панели инструментов и т. д.) на рисунке.

Атрибуты:	figureFigure Рисунок, содержащий холст. keypresslockLockDraw Объект LockDraw, чтобы узнать, заблокирован ли canvas key_press_event. messagelockLockDraw Объект LockDraw, чтобы узнать, доступно ли сообщение для записи.

property active_toggle

В настоящее время переключаемые инструменты.

add_tool(name, tool, *args, **kwargs)[source]

Добавить tool в ToolManager.

При успехе добавляется новое событие tool_trigger_{name}, где {name} — имя инструмента; событие срабатывает каждый раз при активации инструмента.

Параметры:	namestr Имя инструмента, используемое в качестве идентификатора, должно быть уникальным. toolclass_like, т.е. str или type Ссылка для поиска класса добавляемого инструмента.

См. также

matplotlib.backend_tools.ToolBase

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

Примечания

args и kwargs передаются непосредственно в конструктор инструментов.

property canvas

Холст, управляемый FigureManager.

property figure

Рисунок, содержащий холст.

get_tool(name, warn=True)[source]

Возвращает объект инструмента с заданным именем.

Для удобства этот метод передает объекты инструментов.

Параметры:	namestr или ToolBase Имя инструмента или сам инструмент. warnbool, по умолчанию: True Указывает, должно ли отображаться предупреждение, если инструмент с заданным именем отсутствует.
Возвращает:	ToolBase или None Инструмент или None, если инструмент с заданным именем отсутствует.

get_tool_keymap(name)[source]

Возвращает карту сочетаний клавиш, связанную с указанным инструментом.

Параметры:	namestr Имя инструмента.
Возвращает:	список str Список клавиш, связанных с инструментом.

message_event(message, sender=None)[source]

Инициировать событие ToolManagerMessageEvent.

remove_tool(name)[source]

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

Параметры:	namestr Имя инструмента.

set_figure(figure, update_tools=True)[source]

Связать данный рисунок с инструментами.

Параметры:	figureFigure update_toolsbool, по умолчанию: True Принудительно обновить инструменты для отображения рисунка.

toolmanager_connect(s, func)[source]

Установить соединение события s с func.

Параметры:	sstr Имя события. Распознаются следующие события: 'tool_message_event' 'tool_removed_event' 'tool_added_event' Для каждого добавленного инструмента создается новое событие 'tool_trigger_TOOLNAME', где TOOLNAME — идентификатор инструмента. funccallable Функция обратного вызова для события toolmanager со следующим сигнатурой: def func(event: ToolEvent) -> Any
Возвращает:	cid Идентификатор обратного вызова для соединения. Его можно использовать в toolmanager_disconnect.

toolmanager_disconnect(cid)[source]

Отключить обратный вызов с идентификатором cid.

Пример использования:

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)

свойствоtools

Словарь, сопоставляющий имя инструмента —> управляемый инструмент.

trigger_tool(name, sender=None, canvasevent=None, data=None)[source]

Запустить инструмент и вывести событие tool_trigger_{name}.

Параметры:	namestr Имя инструмента. senderобъект Объект, который хочет запустить инструмент. canvaseventEvent Исходное событие холста или None. dataобъект Дополнительные данные для передачи инструменту при запуске.

update_keymap(name, key, *args)[source]

Установить ключевую комбинацию для ассоциации со указанным инструментом.

Параметры:	namestr Имя инструмента. keystr или список str Ключевые комбинации для ассоциации с инструментом.

классmatplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message)[source]

Базовые классы: object

Событие, содержащее сообщения от toolmanager.

Сообщение, как правило, отображается пользователю с помощью панели инструментов.

классmatplotlib.backend_managers.ToolTriggerEvent(name, sender, tool, canvasevent=None, data=None)[source]

Базовые классы: matplotlib.backend_managers.ToolEvent

Событие, уведомляющее о запуске инструмента.