backend_tools — Matplotlib

classmatplotlib.backend_tools.AxisScaleBase(*args, **kwargs)[исходный код]

Базовые классы: ToolToggleBase

Базовый инструмент для переключения между линейной и логарифмической шкалами.

disable(event=None)[исходный код]

Отключить инструмент-переключатель.

trigger вызывает этот метод, когда toggled имеет значение True.

Это может происходить при разных обстоятельствах.

Щелчок по кнопке инструмента на панели инструментов.
Вызов matplotlib.backend_managers.ToolManager.trigger_tool.
Активируется другой инструмент, производный от ToolToggleBase (из того же ToolManager).

enable(event=None)[исходный код]

Включить инструмент-переключатель.

trigger вызывает этот метод, когда toggled имеет значение False.

trigger(sender, event, data=None)[исходный код]: Вызывает enable или disable в зависимости от значения toggled.

classmatplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)[исходный код]

Базовые классы: ToolBase

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

description='Configure subplots'

Описание инструмента.

str: всплывающая подсказка, отображаемая, если инструмент добавлен на панель инструментов.

image='mpl-data/images/subplots'

Имя файла значка.

str | None: имя файла значка на панели инструментов; абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определить как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его опустить, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если указано значение None, в качестве подписи кнопки на панели инструментов используется name.

classmatplotlib.backend_tools.Cursors(*values)[исходный код]

Базовые классы: IntEnum

Типы курсора, независимые от бэкенда.

HAND=2[исходный код]

MOVE=4[исходный код]

POINTER=1[исходный код]

RESIZE_HORIZONTAL=6[исходный код]

RESIZE_VERTICAL=7[исходный код]

SELECT_REGION=3[исходный код]

WAIT=5[исходный код]

classmatplotlib.backend_tools.RubberbandBase(toolmanager, name)[исходный код]

Базовые классы: ToolBase

Нарисовать и удалить рамку выделения.

draw_rubberband(*data)[исходный код]

Нарисовать рамку выделения.

Этот метод должен быть реализован для каждого бэкенда.

remove_rubberband()[исходный код]

Удалить рамку выделения.

Этот метод следует реализовать для каждого бэкенда.

trigger(sender, event, data=None)[исходный код]: Вызвать draw_rubberband или remove_rubberband в зависимости от данных.

classmatplotlib.backend_tools.SaveFigureBase(toolmanager, name)[исходный код]

Базовые классы: ToolBase

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

propertydefault_keymap: Тип единственного экземпляра None.

description='Save the figure'

Описание инструмента.

str: всплывающая подсказка, отображаемая, если инструмент добавлен на панель инструментов.

image='mpl-data/images/filesave'

Имя файла значка.

str | None: имя файла значка на панели инструментов; абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определить как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его опустить, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если указано значение None, в качестве подписи кнопки на панели инструментов используется name.

classmatplotlib.backend_tools.ToolBack(toolmanager, name)[исходный код]

Базовые классы: ViewsPositionsBase

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

propertydefault_keymap: Тип единственного экземпляра None.

description='Back to previous view'

Описание инструмента.

str: всплывающая подсказка, отображаемая, если инструмент добавлен на панель инструментов.

image='mpl-data/images/back'

Имя файла значка.

str | None: имя файла значка на панели инструментов; абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определить как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его опустить, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если указано значение None, в качестве подписи кнопки на панели инструментов используется name.

classmatplotlib.backend_tools.ToolBase(toolmanager, name)[исходный код]

Базовые классы: object

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

Базовый инструмент, который реализует только метод trigger или не реализует никаких методов. Экземпляр инструмента создаётся matplotlib.backend_managers.ToolManager.

propertycanvas: Холст рисунка, на который влияет этот инструмент, или None.

default_keymap=None

Сочетание клавиш, связанное с этим инструментом.

list[str]: список клавиш, нажатие которых запускает этот инструмент при возникновении события нажатия клавиши на self.figure.canvas. Обратите внимание, что значение этого атрибута считывается из экземпляра, поэтому он может быть свойством (это используется, например, встроенными инструментами для загрузки rcParams во время создания экземпляра).

description=None

Описание инструмента.

str: всплывающая подсказка, отображаемая, если инструмент добавлен на панель инструментов.

propertyfigure: Рисунок, на который влияет этот инструмент, или None.

image=None

Имя файла значка.

str | None: имя файла значка на панели инструментов; абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определить как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его опустить, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если указано значение None, в качестве подписи кнопки на панели инструментов используется name.

propertyname: Идентификатор инструмента (str, должен быть уникальным среди инструментов менеджера инструментов).

set_figure(figure)[исходный код]

propertytoolmanager: ToolManager, управляющий этим инструментом.

trigger(sender, event, data=None)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший запуск инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ToolCopyToClipboardBase(toolmanager, name)[исходный код]

Базовые классы: ToolBase

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

propertydefault_keymap: Тип единственного экземпляра None.

description='Copy the canvas figure to clipboard'

Описание инструмента.

str: всплывающая подсказка, отображаемая, если инструмент добавлен на панель инструментов.

trigger(*args, **kwargs)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший запуск инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ToolCursorPosition(*args, **kwargs)[исходный код]

Базовые классы: ToolBase

Отправлять сообщение с текущим положением указателя.

Этот инструмент работает в фоновом режиме и сообщает положение курсора.

send_message(event)[исходный код]: Вызвать matplotlib.backend_managers.ToolManager.message_event.

set_figure(figure)[исходный код]

classmatplotlib.backend_tools.ToolForward(toolmanager, name)[исходный код]

Базовые классы: ViewsPositionsBase

Перейти вперёд по стеку пределов просмотра.

propertydefault_keymap: Тип одиночного объекта None.

description='Forward to next view'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

image='mpl-data/images/forward'

Имя файла значка.

str | None: Имя файла значка панели инструментов: абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определять как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его не указать, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если значение равно None, name используется в качестве подписи кнопки на панели инструментов.

classmatplotlib.backend_tools.ToolFullScreen(toolmanager, name)[исходный код]

Базовые классы: ToolBase

Инструмент для переключения полноэкранного режима.

propertydefault_keymap: Тип одиночного объекта None.

description='Toggle fullscreen mode'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

trigger(sender, event, data=None)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший вызов инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ToolGrid(toolmanager, name)[исходный код]

Базовые классы: ToolBase

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

propertydefault_keymap: Тип одиночного объекта None.

description='Toggle major grids'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

trigger(sender, event, data=None)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший вызов инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ToolHelpBase(toolmanager, name)[исходный код]

Базовые классы: ToolBase

propertydefault_keymap: Тип одиночного объекта None.

description='Print tool list, shortcuts and description'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

staticformat_shortcut(key_sequence)[исходный код]: Преобразовать строку сочетания клавиш из записи, используемой в конфигурации rc, в стандартную запись для отображения сочетаний клавиш, например 'ctrl+a' -> 'Ctrl+A'.

image='mpl-data/images/help'

Имя файла значка.

str | None: Имя файла значка панели инструментов: абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определять как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его не указать, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если значение равно None, name используется в качестве подписи кнопки на панели инструментов.

classmatplotlib.backend_tools.ToolHome(toolmanager, name)[исходный код]

Базовые классы: ViewsPositionsBase

Восстановить исходные пределы просмотра.

propertydefault_keymap: Тип одиночного объекта None.

description='Reset original view'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

image='mpl-data/images/home'

Имя файла значка.

str | None: Имя файла значка панели инструментов: абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определять как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его не указать, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если значение равно None, name используется в качестве подписи кнопки на панели инструментов.

classmatplotlib.backend_tools.ToolMinorGrid(toolmanager, name)[исходный код]

Базовые классы: ToolBase

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

propertydefault_keymap: Тип одиночного объекта None.

description='Toggle major and minor grids'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

trigger(sender, event, data=None)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший вызов инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ToolPan(*args)[исходный код]

Базовые классы: ZoomPanBase

Перемещение по осям левой кнопкой мыши, масштабирование — правой.

cursor=4[исходный код]: Курсор, используемый при активном инструменте.

propertydefault_keymap: Тип одиночного объекта None.

description='Pan axes with left mouse, zoom with right'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

image='mpl-data/images/move'

Имя файла значка.

str | None: Имя файла значка панели инструментов: абсолютный путь или путь относительно каталога, содержащего исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определять как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его не указать, отдельные бэкенды смогут выбрать предпочтительный формат значка. Если значение равно None, name используется в качестве подписи кнопки на панели инструментов.

radio_group='default'

Атрибут для группировки инструментов, работающих по принципу переключателей (взаимоисключающих).

str, определяющее группу, или None, если инструмент не принадлежит ни к одной группе.

classmatplotlib.backend_tools.ToolQuit(toolmanager, name)[исходный код]

Базовые классы: ToolBase

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

propertydefault_keymap: Тип одиночного объекта None.

description='Quit the figure'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

trigger(sender, event, data=None)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший вызов инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ToolQuitAll(toolmanager, name)[исходный код]

Базовые классы: ToolBase

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

propertydefault_keymap: Тип одиночного объекта None.

description='Quit all figures'

Описание инструмента.

str: Подсказка, отображаемая, если инструмент включён в панель инструментов.

trigger(sender, event, data=None)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший вызов инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ToolSetCursor(*args, **kwargs)[исходный код]

Базовые классы: ToolBase

Изменять текущий курсор, когда указатель находится внутри осей.

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

set_figure(figure)[исходный код]

classmatplotlib.backend_tools.ToolToggleBase(*args, **kwargs)[исходный код]

Базовые классы: ToolBase

Переключаемый инструмент.

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

Параметры:

``*args``: Аргумент переменной длины, используемый инструментом.
``**kwargs``: toggled, если он указан и имеет значение True, задаёт начальное состояние инструмента. Произвольные именованные аргументы, которые будут использованы инструментом.

cursor=None: Курсор, используемый при активном инструменте.

default_toggled=False: Состояние переключателя по умолчанию.

disable(event=None)[исходный код]

Отключает переключаемый инструмент.

trigger вызывает этот метод, когда toggled имеет значение True.

Это может произойти при разных обстоятельствах.

Щелчок по кнопке инструмента на панели инструментов.
Вызов matplotlib.backend_managers.ToolManager.trigger_tool.
Вызов другого инструмента, производного от ToolToggleBase (из того же ToolManager).

enable(event=None)[исходный код]

Включает переключаемый инструмент.

trigger вызывает этот метод, когда toggled имеет значение False.

radio_group=None

Атрибут для объединения инструментов типа «радиокнопка» (взаимоисключающих).

str, задающая группу, или None, если инструмент не входит ни в одну группу.

set_figure(figure)[исходный код]

propertytoggled: Состояние переключаемого инструмента.

trigger(sender, event, data=None)[исходный код]: Вызывает enable или disable в зависимости от значения toggled.

classmatplotlib.backend_tools.ToolViewsPositions(*args, **kwargs)[исходный код]

Базовые классы: ToolBase

Вспомогательный инструмент для работы с изменениями областей просмотра и положений.

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

ToolZoom
ToolPan
ToolHome
ToolBack
ToolForward

add_figure(figure)[исходный код]: Добавляет текущий рисунок в стек областей просмотра и положений.

back()[исходный код]: Переходит на один шаг назад в стеке областей просмотра и положений.

clear(figure)[исходный код]: Сбрасывает стек Axes.

forward()[исходный код]: Переходит на один шаг вперёд в стеке областей просмотра и положений.

home()[исходный код]: Восстанавливает первую область просмотра и положение из стека.

push_current(figure=None)[исходный код]: Добавляет текущие пределы области просмотра и положение в соответствующие стеки.

update_home_views(figure=None)[исходный код]: Проверяет, что self.home_views содержит запись для всех Axes, присутствующих в рисунке.

update_view()[исходный код]: Обновляет пределы области просмотра и положение для каждой Axes в соответствии с текущей позицией в стеке. Если в рисунке есть Axes, отсутствующие в текущей позиции стека, для этих Axes используются исходные пределы области просмотра, а положения не обновляются.

classmatplotlib.backend_tools.ToolXScale(*args, **kwargs)[исходный код]

Базовые классы: AxisScaleBase

Инструмент для переключения между линейным и логарифмическим масштабами оси X.

propertydefault_keymap: Тип единственного экземпляра None.

description='Toggle scale X axis'

Описание инструмента.

str: всплывающая подсказка, используемая, если инструмент добавлен на панель инструментов.

set_scale(ax, scale)[исходный код]

classmatplotlib.backend_tools.ToolYScale(*args, **kwargs)[исходный код]

Базовые классы: AxisScaleBase

Инструмент для переключения между линейным и логарифмическим масштабами оси Y.

propertydefault_keymap: Тип единственного экземпляра None.

description='Toggle scale Y axis'

Описание инструмента.

str: всплывающая подсказка, используемая, если инструмент добавлен на панель инструментов.

set_scale(ax, scale)[исходный код]

classmatplotlib.backend_tools.ToolZoom(*args)[исходный код]

Базовые классы: ZoomPanBase

Инструмент для масштабирования с помощью прямоугольной рамки выделения.

cursor=3[исходный код]: Курсор, используемый при активном инструменте.

propertydefault_keymap: Тип единственного экземпляра None.

description='Zoom to rectangle'

Описание инструмента.

str: всплывающая подсказка, используемая, если инструмент добавлен на панель инструментов.

image='mpl-data/images/zoom_to_rect'

Имя файла значка.

str | None: имя файла значка на панели инструментов; абсолютное или относительное к каталогу, содержащему исходный файл Python, в котором определён атрибут класса Tool.image (в последнем случае его нельзя определить как атрибут экземпляра). В обоих случаях расширение указывать необязательно: если его не указать, отдельные бэкенды смогут выбрать предпочитаемый формат значка. Если значение равно None, в качестве подписи кнопки на панели инструментов используется имя.

radio_group='default'

Атрибут для объединения инструментов типа «радиокнопка» (взаимоисключающих).

str, задающая группу, или None, если инструмент не входит ни в одну группу.

classmatplotlib.backend_tools.ViewsPositionsBase(toolmanager, name)[исходный код]

Базовые классы: ToolBase

Базовый класс для ToolHome, ToolBack и ToolForward.

trigger(sender, event, data=None)[исходный код]

Вызывается при использовании этого инструмента.

Этот метод вызывается методом ToolManager.trigger_tool.

Параметры:

eventEvent: Событие холста, вызвавшее этот инструмент.
senderobject: Объект, запросивший вызов инструмента.
dataobject: Дополнительные данные.

classmatplotlib.backend_tools.ZoomPanBase(*args)[исходный код]

Базовые классы: ToolToggleBase

Базовый класс для ToolZoom и ToolPan.

disable(event=None)[исходный код]: Освобождает холст и отключает обработчики событий нажатия и отпускания кнопки мыши.

enable(event=None)[исходный код]: Подключает обработчики событий нажатия и отпускания кнопки мыши и блокирует холст.

scroll_zoom(event)[исходный код]

trigger(sender, event, data=None)[исходный код]: Вызывает enable или disable в зависимости от значения toggled.

matplotlib.backend_tools.add_tools_to_container(container, tools=[['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io', ['save', 'help']]])[исходный код]

Добавляет несколько инструментов в контейнер.

Параметры:

containerContainer: Объект backend_bases.ToolContainerBase, в который будут добавлены инструменты.
toolslist, optional: Список в формате [[group1, [tool1, tool2 ...]], [group2, [...]]], в котором инструменты [tool1, tool2, ...] будут отображаться в группе group1. Подробности см. в backend_bases.ToolContainerBase.add_tool.

matplotlib.backend_tools.add_tools_to_manager(toolmanager, tools={'back': <class 'matplotlib.backend_tools.ToolBack'>, 'copy': <class 'matplotlib.backend_tools.ToolCopyToClipboardBase'>, 'cursor': <class 'matplotlib.backend_tools.ToolSetCursor'>, 'forward': <class 'matplotlib.backend_tools.ToolForward'>, 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'>, 'grid': <class 'matplotlib.backend_tools.ToolGrid'>, 'grid_minor': <class 'matplotlib.backend_tools.ToolMinorGrid'>, 'help': <class 'matplotlib.backend_tools.ToolHelpBase'>, 'home': <class 'matplotlib.backend_tools.ToolHome'>, 'pan': <class 'matplotlib.backend_tools.ToolPan'>, 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'>, 'quit': <class 'matplotlib.backend_tools.ToolQuit'>, 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'>, 'rubberband': <class 'matplotlib.backend_tools.RubberbandBase'>, 'save': <class 'matplotlib.backend_tools.SaveFigureBase'>, 'subplots': <class 'matplotlib.backend_tools.ConfigureSubplotsBase'>, 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>})[исходный код]

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

Параметры:

toolmanagerbackend_managers.ToolManager: Менеджер, в который добавляются инструменты.
tools{str: class_like}, необязательный: Инструменты для добавления в словарь {name: tool}; дополнительную информацию см. в backend_managers.ToolManager.add_tool.

matplotlib.backend_tools.cursors[исходный код]

псевдоним Cursors