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

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

toolclass_like, i.e. str or type

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

См. также

matplotlib.backend_tools.ToolBase

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

Примечания

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

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

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)

propertytools

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

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

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

Параметры

namestr

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

senderобъект

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

canvaseventEvent

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

dataобъект

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

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]

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

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