matplotlib.backend_managers

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

Bases: object

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

classmatplotlib.backend_managers.ToolManager(figure=None)[source]

Базы: object

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

Атрибуты:

figureFigure

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

keypresslockLockDraw

Объект LockDraw для определения, заблокирован ли canvas key_press_event.

messagelockLockDraw

Объект LockDraw для определения, доступно ли сообщение для записи.

propertyactive_toggle

Включенные в данный момент инструменты.

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

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

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

Параметры:

namestr

Имя инструмента, используемое в качестве идентификатора, должно быть уникальным.

toolтип

Класс инструмента, который нужно добавить. Будет использоваться подкласс, если для текущего класса холста был зарегистрирован подкласс.

*args, **kwargs

Передаются конструктору tool.

См. также

matplotlib.backend_tools.ToolBase

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

propertycanvas

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

propertyfigure

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

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 — идентификатор инструмента.

funcвызываемая функция

Обработчик событий 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)

propertytools

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

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

Вызов инструмента и отправка события tool_trigger_{name}.

Параметры:

namestr

Имя инструмента.

senderobject

Объект, который желает вызвать инструмент.

canvaseventEvent

Исходное событие холста или None.

dataobject

Дополнительные данные, которые необходимо передать инструменту при вызове.

update_keymap(name, key)[source]

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

Параметры:

namestr

Имя инструмента.

keystr или список str

Клавиши для ассоциации с инструментом.

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

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

Событие, несущее сообщения от toolmanager.

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

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

Базовое класс: ToolEvent

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