matplotlib.backend_managers

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

Bases: object

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

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

Bases: object

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

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

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

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

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

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

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

См. также

matplotlib.backend_tools.ToolBase: Базовый класс для инструментов.

Примечания

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

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

property figure: Figure, содержащий холст.

get_tool(self, name, warn=True) [source]

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

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

Параметры:	`namestr or ToolBase` Имя инструмента или сам инструмент. `warnbool, default: True` Флаг, указывающий, должно ли генерироваться предупреждение, если инструмент с заданным именем не существует.
Возвращает:	`ToolBase or None` Инструмент или None, если инструмент с заданным именем не существует.

get_tool_keymap(self, name) [source]

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

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

message_event(self, message, sender=None) [source]: Генерирует событие ToolManagerMessageEvent.

remove_tool(self, name) [source]

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

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

set_figure(self, figure, update_tools=True) [source]

Привязывает заданную figure к инструментам.

Параметры:	`figureFigure` `update_toolsbool, default: True` Принудительно обновляет инструменты в соответствии с figure.

toolmanager_connect(self, 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`.

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(self, cid) [source]

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

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

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

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

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

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

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

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

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

Параметры:	`namestr` Имя инструмента. `keysstr or list of str` Ключи для сопоставления с инструментом.

class matplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message) [source]

Bases: object

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

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

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

Bases: matplotlib.backend_managers.ToolEvent

Событие, информирующее о том, что инструмент был запущен.