Spec-Zone.ru › Matplotlib 3.1

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.

Атрибуты:
figure : Figure

Figure, содержащая холст.

keypresslock : widgets.LockDraw

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

messagelock : widgets.LockDraw

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

active_toggle

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

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

Добавить инструмент в ToolManager.

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

Параметры:
name : str

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

tool : class_like, i.e. str or type

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

См. также

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

Примечания

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

canvas

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

figure

Figure, содержащая холст.

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

Возвращает объект инструмента, также принимает сам инструмент для удобства.

Параметры:
name : str, ToolBase

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

warn : bool, optional

Если метод должен выводить предупреждения.

get_tool_keymap(self, name) [source]

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

Параметры:
name : string

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

Возвращает:
list : list of keys associated with the Tool
message_event(self, message, sender=None) [source]

Вывести событие ToolManagerMessageEvent.

remove_tool(self, name) [source]

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

Параметры:
name : string

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

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

Привязать заданную фигуру к инструментам.

Параметры:
figure : Figure
update_tools : bool

Вынудить инструменты обновить фигуру

toolmanager_connect(self, s, func) [source]

Подключить событие с строкой s к func.

Параметры:
s : String

Имя события

Распознаются следующие события:

  • 'tool_message_event'
  • 'tool_removed_event'
  • 'tool_added_event'

Для каждого добавленного инструмента создается новое событие

  • 'tool_trigger_TOOLNAME` Где TOOLNAME — идентификатор инструмента.
func : function

Функция, которая будет вызываться с подписью def func(event)

toolmanager_disconnect(self, cid) [source]

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

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

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

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

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

Активировать инструмент и вывести событие tool_trigger_{name}.

Параметры:
name : string

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

sender : object

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

canvasevent : Event

Оригинальное событие холста или None

data : Object

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

update_keymap(self, name, *keys) [source]

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

Параметры:
name : string

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

keys : keys 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.1.1/api/backend_managers_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API