Spec-Zone.ru › Matplotlib 3.0

matplotlib.backend_managers

ToolManager
Класс, который обеспечивает связь между взаимодействием пользователя (нажатие клавиш, щелчки на панели инструментов и т. д.) и действиями в ответ на эти действия пользователя.
class matplotlib.backend_managers.ToolEvent(name, sender, tool, data=None) [source]

Базы: object

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

class matplotlib.backend_managers.ToolManager(figure=None) [source]

Базы: object

Вспомогательный класс, который группирует все взаимодействия пользователя для Figure.

Атрибуты:
figure: `Figure`
keypresslock: `widgets.LockDraw`

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

messagelock: `widgets.LockDraw`

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

active_toggle

Текущие переключаемые инструменты

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

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

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

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

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

tool : class_like, i.e. str or type

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

См. также

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

Примечания

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

canvas

Объект Canvas, управляемый FigureManager

figure

Figure, содержащий Canvas

get_tool(name, warn=True) [source]

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

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

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

warn : bool, optional

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

get_tool_keymap(name) [source]

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

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

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

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

Вызвать ToolManagerMessageEvent

remove_tool(name) [source]

Удалить инструмент из ToolManager

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

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

set_figure(figure, update_tools=True) [source]

Связать данную figure с инструментами.

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

Принудительно обновить инструменты figure

toolmanager_connect(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(cid) [source]

Отключить обратный вызов id cid

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

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

Возвращает инструменты, управляемые ToolManager

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

Вызвать инструмент и вывести событие tool_trigger_[name]

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

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

sender: object

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

canvasevent : Event

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

data : Object

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

update_keymap(name, *keys) [source]

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

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

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

keys : keys to associate with the Tool
class matplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message) [source]

Bases: object

Событие, передающее сообщения от менеджера инструментов

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

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.0.0/api/backend_managers_api.html

Spec-Zone.ru

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