Spec-Zone.ru › Matplotlib 2.1

matplotlib.backend_managers

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

Bases: object

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

class matplotlib.backend_managers.ToolManager(figure=None)

Bases: object

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

Атрибуты

manager: `FigureManager`
keypresslock: `widgets.LockDraw` LockDraw объект для определения, заблокирован ли canvas обработчик нажатия клавиш.
messagelock: `widgets.LockDraw` LockDraw объект для определения, доступно ли сообщение для записи.
active_toggle

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

add_tool(name, tool, *args, **kwargs)

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

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

Параметры:

name : str

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

tool : class_like, т. е. str или тип

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

См. также

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

Примечания

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

canvas

Поверхность отображения, управляемая FigureManager.

figure

Диаграмма, содержащая поверхность отображения.

get_tool(name, warn=True)

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

Параметры:

name : str, ToolBase

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

warn : bool, необязательно

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

get_tool_keymap(name)

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

Параметры:

name : строка

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

Возвращает:

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

message_event(message, sender=None)

Выдача события ToolManagerMessageEvent.

remove_tool(name)

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

Параметры:

name : строка

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

set_figure(figure, update_tools=True)

Устанавливает диаграмму для взаимодействия с инструментами.

Параметры:

figure: `Figure`

update_tools: bool

Принудительно обновить инструменты для обновления диаграммы.

toolmanager_connect(s, func)

Установить связь события с строкой s с func.

Параметры:

s : Строка

Имя события.

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

  • ‘tool_message_event’
  • ‘tool_removed_event’
  • ‘tool_added_event’

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

  • ‘tool_trigger_TOOLNAME`, где TOOLNAME — идентификатор инструмента.

func : функция

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

toolmanager_disconnect(cid)

Отключение обратного вызова 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)

Активация инструмента и выдача события tool_trigger_[name].

Параметры:

name : строка

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

sender: объект

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

canvasevent : Событие

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

data : Объект

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

update_keymap(name, *keys)

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

Параметры:

name : строка

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

keys : клавиши для связывания с инструментом.

class matplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message)

Bases: object

Событие, несущее сообщения от toolmanager.

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

class matplotlib.backend_managers.ToolTriggerEvent(name, sender, tool, canvasevent=None, data=None)

Bases: matplotlib.backend_managers.ToolEvent

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

© 2012–2017 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
http://matplotlib.org/2.1.0/api/backend_managers_api.html

Spec-Zone.ru

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