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, содержащий холст.
-
keypresslockwidgets.LockDraw -
LockDrawобъект, определяющий, заблокирован ли ключcanvaskey_press_event -
messagelockwidgets.LockDraw -
LockDrawобъект, определяющий, доступно ли сообщение для записи
-
property active_toggle -
В настоящее время переключаемые инструменты.
-
add_tool(self, name, tool, *args, **kwargs)[source] -
Добавить инструмент в
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, ToolBase -
Имя инструмента или сам инструмент
-
warnbool, optional -
Если этот метод должен выдавать предупреждения.
-
-
get_tool_keymap(self, name)[source] -
Получить карту клавиш, связанную с указанным инструментом.
Параметры: -
namestr -
Имя инструмента.
Возвращает: -
listlist of keys associated with the Tool
-
-
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 -
Принудительное обновление фигуры инструментами
-
-
toolmanager_connect(self, s, func)[source] -
Подключить событие со строкой s к func.
Параметры: -
sString -
Имя события
Распознаются следующие события:
- 'tool_message_event'
- 'tool_removed_event'
- 'tool_added_event'
Для каждого добавленного инструмента создается новое событие
- 'tool_trigger_TOOLNAME` Где TOOLNAME — идентификатор инструмента.
-
funcfunction -
Функция, вызываемая с сигнатурой def func(event)
-
-
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, *keys)[source] -
Установить карту клавиш для сопоставления с указанным инструментом.
Параметры: -
namestr -
Имя инструмента.
-
keyskeys to associate with the Tool
-
-
-
class matplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message)[source] -
Bases:
objectСобытие, содержащее сообщения от toolmanager.
Сообщения обычно отображаются пользователю на панели инструментов.
-
class matplotlib.backend_managers.ToolTriggerEvent(name, sender, tool, canvasevent=None, data=None)[source] -
Bases:
matplotlib.backend_managers.ToolEventСобытие, информирующее о том, что инструмент был запущен.
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.2.2/api/backend_managers_api.html