Spec-Zone.ru › Matplotlib 1.5

matplotlib.backend_managers

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

Bases: object

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

class matplotlib.backend_managers.ToolManager(canvas)

Bases: object

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

Атрибуты

manager: FigureManager
keypresslock: widgets.LockDraw LockDraw объект, определяющий, заблокирован ли canvas key_press_event
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
Базовый класс для инструментов.

Примечания

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

get_tool(name, warn=True)

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

Параметры:

name : str, ToolBase

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

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

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

get_tool_keymap(name)

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

Параметры:

name : строка

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

Возвращает:

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

message_event(message, sender=None)

Вызывает событие ToolManagerMessageEvent

remove_tool(name)

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

Параметры:

name : строка

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

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 : строка

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

sender: объект

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

canvasevent : Событие

Исходное событие холста или 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–2016 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
http://matplotlib.org/1.5.3/api/backend_managers_api.html

Spec-Zone.ru

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