Spec-Zone.ru › Matplotlib 2.2

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`
keypresslock: `widgets.LockDraw`

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

messagelock: `widgets.LockDraw`

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

active_toggle

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

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

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

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

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

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

tool : class_like, i.e. str or type

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

См. также

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

Примечания

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

canvas

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

figure

Фигура, содержащая поверхность

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`
update_tools: bool

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

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
END_OF_DOCUMENT_MARKER ```
class matplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message) [source]

Базы: object

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

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

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

Базы: matplotlib.backend_managers.ToolEvent

Событие, информирующее о том, что инструмент был запущен

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/2.2.3/api/backend_managers_api.html

Spec-Zone.ru

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