matplotlib.backend_managers

classmatplotlib.backend_managers.ToolEvent(name, sender, tool, data=None)[исходный код]

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

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

classmatplotlib.backend_managers.ToolManager(figure=None)[исходный код]

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

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

Атрибуты:

figureFigure

Объект Figure, содержащий холст.

keypresslockLockDraw

Объект LockDraw, позволяющий определить, заблокировано ли событие key_press_event для canvas.

messagelockLockDraw

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

propertyactive_toggle

Инструменты, переключённые в данный момент.

add_tool(name, tool, *args, **kwargs)[исходный код]

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

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

Параметры:

namestr

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

tooltype

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

*args, **kwargs

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

См. также

matplotlib.backend_tools.ToolBase

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

propertycanvas

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

propertyfigure

Объект Figure, содержащий холст.

get_tool(name, warn=True)[исходный код]

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

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

Параметры:

namestr или ToolBase

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

warnbool, по умолчанию: True

Следует ли выдать предупреждение, если инструмент с указанным именем не существует.

Возвращает:

ToolBase или None

Инструмент или None, если инструмента с указанным именем не существует.

get_tool_keymap(name)[исходный код]

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

Параметры:

namestr

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

Возвращает:

list of str

Список клавиш, связанных с инструментом.

message_event(message, sender=None)[исходный код]

Вызвать событие ToolManagerMessageEvent.

remove_tool(name)[исходный код]

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

Параметры:

namestr

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

set_figure(figure, update_tools=True)[исходный код]

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

Параметры:

figureFigure

update_toolsbool, по умолчанию: True

Принудительно обновить объект Figure для инструментов.

toolmanager_connect(s, func)[исходный код]

Подключить событие со строковым именем 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)[исходный код]

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

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

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

propertytools

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

trigger_tool(name, sender=None, canvasevent=None, data=None)[исходный код]

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

Параметры:

namestr

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

senderobject

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

canvaseventEvent

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

dataobject

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

update_keymap(name, key)[исходный код]

Задать сочетания клавиш для указанного инструмента.

Параметры:

namestr

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

keystr или list of str

Клавиши, связанные с инструментом.

classmatplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message)[исходный код]

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

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

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

classmatplotlib.backend_managers.ToolTriggerEvent(name, sender, tool, canvasevent=None, data=None)[исходный код]

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

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