matplotlib.backend_bases

Абстрактные базовые классы определяют примитивы, которые должны реализовывать отрисовщики и графические контексты для работы в качестве бэкенда Matplotlib.

RendererBase

Абстрактный базовый класс для обработки операций рисования/отрисовки.

FigureCanvasBase

Уровень абстракции, отделяющий Figure от зависимостей от конкретного бэкенда, таких как область рисования пользовательского интерфейса.

GraphicsContextBase

Абстрактный базовый класс, предоставляющий цвет, стили линий и т. д.

Event

Базовый класс для всех обработок событий Matplotlib. Производные классы, такие как KeyEvent и MouseEvent, хранят метаданные, такие как нажатые клавиши и кнопки, координаты x и y в пикселях и координатах Axes.

ShowBase

Базовый класс для класса Show каждого интерактивного бэкенда; вызываемый объект «show» затем устанавливается в Show.__call__.

ToolContainerBase

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

classmatplotlib.backend_bases.CloseEvent(name, canvas, guiEvent=None)[source]

Bases: Event

Событие, срабатывающее при закрытии фигуры.

classmatplotlib.backend_bases.DrawEvent(name, canvas, renderer)[source]

Bases: Event

Событие, срабатывающее при операции рисования на холсте.

В большинстве бэкендов обратные вызовы, подписки на это событие, будут вызваны после завершения отрисовки, но до обновления экрана. Любые дополнительные художники, нарисованные в отрисовщике холста, будут отображены без явного вызова blit.

Предупреждение

Вызов canvas.draw и canvas.blit в этих обратных вызовах может быть небезопасным для всех бэкендов и может привести к бесконечной рекурсии.

У события DrawEvent есть ряд специальных атрибутов помимо тех, которые определены родительским классом Event.

Атрибуты:

rendererRendererBase

Отрисовщик для события рисования.

classmatplotlib.backend_bases.Event(name, canvas, guiEvent=None)[source]

Bases: object

Событие Matplotlib.

Ниже определены атрибуты и показаны их значения по умолчанию. Подклассы могут определять дополнительные атрибуты.

Атрибуты:

namestr

Имя события.

canvasFigureCanvasBase

Инстанс холста конкретного бэкенда, генерирующего событие.

guiEvent

Событие GUI, которое вызвало событие Matplotlib.

classmatplotlib.backend_bases.FigureCanvasBase(figure=None)[source]

Базы: object

Поверхность холста, на которой отрисовывается фигура.

Атрибуты:

figureFigure

Экземпляр фигуры высокого уровня.

blit(bbox=None)[source]

Отобразить холст в области bbox (по умолчанию весь холст).

propertybutton_pick_id

button_press_event(x, y, button, dblclick=False, guiEvent=None)[source]

[Устарело] Обработка событий нажатия кнопки мыши.

Производные классы бэкенда должны вызывать эту функцию при любом нажатии кнопки мыши. (x, y) — координаты на холсте ((0, 0) — нижний левый угол). button и key определяются в MouseEvent.

Этот метод вызовет все функции, подключенные к событию 'button_press_event', с экземпляром MouseEvent.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('button_press_event', MouseEvent(...)) вместо этого.

button_release_event(x, y, button, guiEvent=None)[source]

[Устарело] Обработка событий отпускания кнопки мыши.

Производные классы бэкенда должны вызывать эту функцию при любом отпускании кнопки мыши.

Этот метод вызовет все функции, подключенные к событию 'button_release_event', с экземпляром MouseEvent.

Параметры:

xfloat

Координаты на холсте, где 0=слева.

yfloat

Координаты на холсте, где 0=снизу.

guiEvent

Событие native UI, сгенерировавшее событие Matplotlib.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('button_release_event', MouseEvent(...)) вместо этого.

propertycallbacks

close_event(guiEvent=None)[source]

[Устарело] Передать CloseEvent всем функциям, подключенным к close_event.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('close_event', CloseEvent(...)) вместо этого.

propertydevice_pixel_ratio

Соотношение физических и логических пикселей, используемых для холста на экране.

По умолчанию это 1, что означает, что физические и логические пиксели имеют одинаковый размер. Подклассы, поддерживающие экраны с высоким разрешением, могут установить это свойство, чтобы указать, что это соотношение отличается. Взаимодействие Matplotlib, если оно не работает напрямую с холстом, остается в логических пикселях.

draw(*args, **kwargs)[source]

Отображение Figure.

Этот метод должен пройти по дереву элементов, даже если вывод не производится, потому что он запускает отложенную работу, к которой пользователи могут получить доступ перед сохранением вывода на диск. Например, вычисление пределов, автоматических пределов и значений меток.

draw_event(renderer)[source]

[Устарело] Передать DrawEvent всем функциям, подключенным к draw_event.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('draw_event', DrawEvent(...)) вместо этого.

draw_idle(*args, **kwargs)[source]

Запросить перерисовку виджета, когда управление вернется к циклу событий GUI.

Даже если несколько вызовов draw_idle произойдут до того, как управление вернется к циклу событий GUI, фигура будет отрисована только один раз.

Примечания

Бэкенды могут переопределить метод и реализовать свою собственную стратегию для предотвращения нескольких рендерингов.

enter_notify_event(guiEvent=None, *, xy)[source]

[Устарело] Обработка событий входа курсора мыши в холст.

Производные классы бэкенда должны вызывать эту функцию при входе в холст.

Параметры:

guiEvent

Событие native UI, сгенерировавшее событие Matplotlib.

xy(float, float)

Координаты указателя при входе в холст.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('enter_notify_event', LocationEvent(...)) вместо этого.

events=['resize_event', 'draw_event', 'key_press_event', 'key_release_event', 'button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event', 'pick_event', 'figure_enter_event', 'figure_leave_event', 'axes_enter_event', 'axes_leave_event', 'close_event']

filetypes={'eps': 'Encapsulated Postscript', 'jpeg': 'Группы экспертов по совместной фотографии', 'jpg': 'Группы экспертов по совместной фотографии', 'pdf': 'Формат портативных документов', 'pgf': 'Код PGF для LaTeX', 'png': 'Портативная графика сети', 'ps': 'Постскрипт', 'raw': 'Необработанное RGBA-растровое изображение', 'rgba': 'Необработанное RGBA-растровое изображение', 'svg': 'Векторная графика с масштабируемым форматом', 'svgz': 'Векторная графика с масштабируемым форматом', 'tif': 'Формат файла изображения с метками', 'tiff': 'Формат файла изображения с метками', 'webp': 'Формат изображения WebP'}

fixed_dpi=None

flush_events()[source]

Очистить события графического интерфейса для фигуры.

Интерактивные бэкэнды должны переопределить этот метод.

get_default_filename()[source]

Возвращает строку, включающую расширение, подходящую для использования в качестве имени файла по умолчанию.

classmethodget_default_filetype()[source]

Возвращает формат файла сохранения по умолчанию, как указано в rcParams["savefig.format"] (по умолчанию: 'png').

Возвращаемая строка не включает точку. Этот метод переопределяется в бэкендах, которые поддерживают только один тип файла.

classmethodget_supported_filetypes()[source]

Возвращает словарь поддерживаемых форматов файлов сохранения для этого бэкэнда.

classmethodget_supported_filetypes_grouped()[source]

Возвращает словарь поддерживаемых форматов файлов сохранения для этого бэкэнда, где ключи — имена типов файлов, например, «Группы экспертов по совместной фотографии», а значения — список расширений файлов, используемых для этого типа файла, например, ['jpg', 'jpeg'].

get_width_height(*, physical=False)[source]

Возвращает ширину и высоту фигуры в целочисленных точках или пикселях.

При использовании фигуры на экранах с высокой плотностью пикселей (и если бэкенд это поддерживает), усечение до целых чисел происходит после масштабирования с учётом соотношения пикселей устройства.

Параметры:

physicalbool, по умолчанию: False

Указывает, возвращать ли истинные физические пиксели или логические пиксели. Физические пиксели могут использоваться бэкендами, поддерживающими HiDPI, но всё ещё настраивающими холст с использованием его фактического размера.

Возвращаемое значение:

width, heightint

Размер фигуры в точках или пикселях, в зависимости от бэкэнда.

grab_mouse(ax)[source]

Устанавливает дочерний Axes, который захватывает события мыши.

Обычно вызывается самими виджетами. Вызов этого метода, если мышь уже захвачена другим объектом Axes, является ошибкой.

inaxes(xy)[source]

Возвращает самый верхний видимый Axes, содержащий точку xy.

Параметры:

xy(float, float)

(x, y) координаты пикселей слева/снизу холста.

Возвращаемое значение:

Axes или None

Самый верхний видимый объект Axes, содержащий точку, или None, если в точке нет объекта Axes.

is_saving()[source]

Возвращает, находится ли рендерер в процессе сохранения в файл, а не рендеринга для буфера на экране.

key_press_event(key, guiEvent=None)[source]

[Устарело] Передает KeyEvent всем функциям, подключенным к key_press_event.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('key_press_event', KeyEvent(...)) вместо этого.

key_release_event(key, guiEvent=None)[source]

[Устарело] Передает KeyEvent всем функциям, подключенным к key_release_event.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('key_release_event', KeyEvent(...)) вместо этого.

leave_notify_event(guiEvent=None)[source]

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

Классы, производные от бэкэнда, должны вызывать эту функцию при выходе с холста.

Параметры:

guiEvent

Оригинальное событие пользовательского интерфейса, которое сгенерировало событие Matplotlib.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('leave_notify_event', LocationEvent(...)) вместо этого.

manager_class[source]

псевдоним для FigureManagerBase

motion_notify_event(x, y, guiEvent=None)[source]

[Устаревшее] Обработка событий перемещения мыши.

Производные классы бэкенда должны вызывать эту функцию при любом событии перемещения мыши.

Этот метод вызовет все функции, подключенные к событию 'motion_notify_event', с экземпляром MouseEvent.

Параметры:

xfloat

Координаты по горизонтали на холсте, где 0=левый край.

yfloat

Координаты по вертикали на холсте, где 0=нижняя граница.

guiEvent

Родное событие пользовательского интерфейса, которое сгенерировало событие Matplotlib.

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('motion_notify_event', MouseEvent(...)) вместо этого.

mpl_connect(s, func)[source]

Привязывает функцию func к событию s.

Параметры:

sstr

Один из следующих идентификаторов событий:

• 'button_press_event'
• 'button_release_event'
• 'draw_event'
• 'key_press_event'
• 'key_release_event'
• 'motion_notify_event'
• 'pick_event'
• 'resize_event'
• 'scroll_event'
• 'figure_enter_event',
• 'figure_leave_event',
• 'axes_enter_event',
• 'axes_leave_event'
• 'close_event'.

funccallable

Функция обратного вызова, которая должна иметь следующий сигнатуру:

def func(event: Event) -> Any

Для событий расположения (нажатия и отпускания кнопок, нажатия клавиш), если мышь находится над осями, атрибут inaxes события будет установлен на Axes, над которой находится мышь в момент события, а также переменные xdata и ydata атрибуты будут установлены на координаты мыши в координатах данных. Смотрите KeyEvent и MouseEvent для получения дополнительной информации.

Примечание

Если func является методом, это хранит только слабую ссылку на метод. Таким образом, рисунок не влияет на время жизни связанного объекта. Обычно вы хотите убедиться, что объект остается активным в течение всего срока службы рисунка, сохраняя ссылку на него.

Возвращает:

cid

Идентификатор соединения, который можно использовать с FigureCanvasBase.mpl_disconnect.

Примеры

def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = canvas.mpl_connect('button_press_event', on_press)

mpl_disconnect(cid)[source]

Отключить обратный вызов с идентификатором cid.

Примеры

cid = canvas.mpl_connect('button_press_event', on_press)
# ... later
canvas.mpl_disconnect(cid)

classmethodnew_manager(figure, num)[source]

Создать новый менеджер для рисунка figure, используя этот класс холста.

Примечания

Этот метод не следует переопределять в подклассах. Если требуется логика создания пользовательского менеджера, переопределите FigureManager.create_with_canvas.

new_timer(interval=None, callbacks=None)[source]

Создать новый бэкенд-специфический подкласс Timer.

Это полезно для получения периодических событий через собственный цикл событий бэкенда. Реализовано только для бэкэндов с графическим интерфейсом.

Параметры:

intervalint

Интервал таймера в миллисекундах.

callbackslist[tuple[callable, tuple, dict]]

Последовательность (func, args, kwargs), где func(*args, **kwargs) будет выполняться таймером каждые interval.

Обратные вызовы, возвращающие False или 0, будут удалены из таймера.

Примеры

>>> timer = fig.canvas.new_timer(callbacks=[(f1, (1,), {'a': 3})])

pick(mouseevent)[source]

[Устаревшее]

Примечания

Устарело начиная с версии 3.6: Используйте canvas.figure.pick вместо этого.

pick_event(mouseevent, artist, **kwargs)[source]

[Устаревшее] Обработка событий выбора.

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

Обратите внимание, что артисты по умолчанию не являются выбираемыми (см. Artist.set_picker).

Примечания

Устарело начиная с версии 3.6: Используйте callbacks.process('pick_event', PickEvent(...)) вместо этого.

print_figure(filename, dpi=None, facecolor=None, edgecolor=None, orientation='portrait', format=None, *, bbox_inches=None, pad_inches=None, bbox_extra_artists=None, backend=None, **kwargs)[source]

Вывод рисунка на печать. Установка цвета заливки и обводки области рисунка. Это полезно, так как некоторые GUI имеют серую заливку фона области рисунка, и вы, вероятно, захотите переопределить её для печатных выходов.

Параметры:

filenameстрока или путь к файлу или файлоподобный объект

Файл, куда сохраняется рисунок.

dpiвещественное число, по умолчанию rcParams["savefig.dpi"] (по умолчанию 'figure')

Точек на дюйм для сохранения рисунка.

facecolorцвет или 'auto', по умолчанию rcParams["savefig.facecolor"] (по умолчанию 'auto')

Цвет заливки области рисунка. Если 'auto', используется текущий цвет заливки.

edgecolorцвет или 'auto', по умолчанию rcParams["savefig.edgecolor"] (по умолчанию 'auto')

Цвет обводки области рисунка. Если 'auto', используется текущий цвет обводки.

orientation{'landscape', 'portrait'}, по умолчанию 'portrait'

В настоящее время применяется только для печати в формате PostScript.

formatстрока, необязательно

Принудительно задать определенный формат файла. Если не указано, формат определяется по расширению имени файла, а если это не удается, по rcParams["savefig.format"] (по умолчанию 'png').

bbox_inches'tight' или Bbox, по умолчанию rcParams["savefig.bbox"] (по умолчанию None)

Ограничивающая рамка в дюймах: сохраняется только указанная часть рисунка. Если 'tight', то пытается определить наиболее узкую ограничивающую рамку рисунка.

pad_inchesвещественное число, по умолчанию rcParams["savefig.pad_inches"] (по умолчанию 0.1)

Величина отступа вокруг рисунка, когда bbox_inches равно 'tight'.

bbox_extra_artistsсписок объектов Artist, необязательно

Список дополнительных графических объектов, которые будут учитываться при вычислении ограничивающей рамки.

backendстрока, необязательно

Используйте нестандартный бэкенд для рендеринга файла, например, для рендеринга файла png с бэкендом "cairo" вместо стандартного "agg", или файла pdf с бэкендом "pgf" вместо стандартного "pdf". Обратите внимание, что по умолчанию бэкенд обычно достаточен. См. Встроенные бэкенды для списка допустимых бэкендов для каждого формата файла. Пользовательские бэкенды могут быть указаны как "module://...".

release_mouse(ax)[source]

Отпускает захват мыши, удерживаемый объектом Axes ax.

Обычно вызывается виджетами. Хорошо вызывать это, даже если ax не захватывает мышь в данный момент.

required_interactive_framework=None

resize(w, h)[source]

НЕ ИСПОЛЬЗУЕТСЯ: Установка размера холста в пикселях.

Некоторые бэкенды могут реализовать аналогичный метод внутри, но это не является требованием Matplotlib и не используется им.

resize_event()[source]

[Устарело] Передает ResizeEvent всем функциям, подключённым к resize_event.

Примечания

Устарело начиная с версии 3.6: Вместо этого используйте callbacks.process('resize_event', ResizeEvent(...)).

scroll_event(x, y, step, guiEvent=None)[source]

[Устарело] Обработка событий прокрутки.

Производные классы бэкендов должны вызывать эту функцию при любом событии прокрутки колеса мыши. (x, y) — координаты на холсте ((0, 0) — нижний левый угол). button и key определяются как в MouseEvent.

Этот метод вызовет все функции, подключенные к «scroll_event», с экземпляром MouseEvent.

Примечания

Устарело начиная с версии 3.6: Вместо этого используйте callbacks.process('scroll_event', MouseEvent(...)).

propertyscroll_pick_id

set_cursor(cursor)[source]

Установить текущий курсор.

Это может не иметь эффекта, если бэкенд ничего не отображает.

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

Параметры:

cursorCursors

Курсор для отображения над холстом. Примечание: некоторые бэкенды могут изменить курсор для всего окна.

start_event_loop(timeout=0)[source]

Запустить блокирующую цикл обработки событий.

Такой цикл обработки событий используется интерактивными функциями, такими как ginput и waitforbuttonpress, для ожидания событий.

Цикл обработки событий блокируется до тех пор, пока функция обратного вызова не вызовет stop_event_loop, или не истечёт timeout.

Если timeout равен 0 или отрицательному значению, ожидание никогда не истечёт.

Переопределять этот метод нужно только для интерактивных бэкэндов, и он полагается на корректную реализацию метода flush_events.

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

stop_event_loop()[source]

Остановить текущий блокирующий цикл обработки событий.

Интерактивные бэкэнды должны переопределить этот метод в соответствии с start_event_loop

supports_blit=False

switch_backends(FigureCanvasClass)[source]

Создаёт экземпляр класса FigureCanvasClass.

Используется для переключения бэкэндов, например, для создания FigureCanvasPS из FigureCanvasGTK. Обратите внимание, что глубокое копирование не выполняется, поэтому любые изменения в одном из экземпляров (например, установка размера фигуры или свойств линий) будут отражены в другом.

classmatplotlib.backend_bases.FigureManagerBase(canvas, num)[source]

Bases: object

Абстракция, не зависящая от бэкэнда, контейнера и контроллера фигур.

Менеджер фигур используется pyplot для взаимодействия с окном независимо от бэкэнда. Это адаптер для реальной (графической) среды, представляющий визуальную фигуру на экране.

Графические бэкэнды определяют методы этого класса для перевода общих операций, таких как отображение или изменение размера, в специфичный для графической среды код. Бэкэнды, не основанные на графике, не поддерживают эти операции и могут просто использовать базовый класс.

Доступны следующие базовые операции:

Операции с окном

• show
• destroy
• full_screen_toggle
• resize
• get_window_title
• set_window_title

Обработка нажатий клавиш и кнопок мыши

Менеджер фигур устанавливает обработку нажатий клавиш и кнопок мыши по умолчанию, подключив key_press_handler к системе событий matplotlib. Это гарантирует одинаковые сочетания клавиш и действия мыши на разных бэкэндах.

Другие операции

Подклассы будут иметь дополнительные атрибуты и функции для доступа к дополнительным возможностям. Это, конечно, зависит от бэкэнда. Например, большинство графических бэкэндов имеют атрибуты window и toolbar, которые обеспечивают доступ к собственным графическим виджетам соответствующей среды.

Атрибуты:

canvasFigureCanvasBase

Экземпляр канваса, специфичный для бэкэнда.

numint или str

Номер фигуры.

key_press_handler_idint

Идентификатор обработчика клавиш по умолчанию, при использовании toolmanager. Чтобы отключить обработку нажатий клавиш по умолчанию, используйте:

figure.canvas.mpl_disconnect(
    figure.canvas.manager.key_press_handler_id)

button_press_handler_idint

Идентификатор обработчика нажатий кнопок мыши по умолчанию, при использовании toolmanager. Чтобы отключить обработку нажатий кнопок мыши по умолчанию, используйте:

figure.canvas.mpl_disconnect(
    figure.canvas.manager.button_press_handler_id)

classmethodcreate_with_canvas(canvas_class, figure, num)[source]

Создать менеджер для заданной figure с использованием определённого canvas_class.

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

destroy()[source]

full_screen_toggle()[source]

get_window_title()[source]

Возвращает текст заголовка окна, содержащего фигуру, или None, если окна нет (например, в бэкэнде PS).

classmethodpyplot_show(*, block=None)[source]

Отобразить все фигуры. Этот метод является реализацией pyplot.show.

Для настройки поведения pyplot.show, интерактивные бэкэнды обычно должны переопределять start_main_loop; если нужна более настраиваемая логика, можно переопределить и pyplot_show.

Параметры:

blockbool, необязательно

Блокировать вызов start_main_loop. Значение по умолчанию None означает блокировку, если мы не в режиме %pylab IPython или в режиме interactive.

resize(w, h)[source]

Для графических бэкэндов, изменить размер окна (в физических пикселях).

set_window_title(title)[source]

Установить текст заголовка окна, содержащего фигуру.

Для бэкэндов, не основанных на графике (например, PS), это не имеет эффекта.

show()[source]

Для графических бэкэндов, отобразить окно фигуры и перерисовать. Для бэкэндов, не основанных на графике, выбросить исключение, если не выполняется в режиме без графической среды (например, в Linux без установленного DISPLAY); это исключение преобразуется в предупреждение в Figure.show.

classmethodstart_main_loop()[source]

Запустить главный цикл событий.

Этот метод вызывается FigureManagerBase.pyplot_show, который является реализацией pyplot.show. Для настройки поведения pyplot.show, интерактивные бэкэнды обычно должны переопределять start_main_loop; если нужна более настраиваемая логика, можно переопределить и pyplot_show.

классmatplotlib.backend_bases.GraphicsContextBase[source]

Bases: object

Абстрактный базовый класс, предоставляющий цвет, стили линий и т. д.

copy_properties(gc)[source]

Копирование свойств из gc в self.

get_alpha()[source]

Возвращает значение альфа-канала, используемого для смешивания. Не поддерживается во всех бэкендах.

get_antialiased()[source]

Возвращает значение, определяющее, следует ли использовать антиалиасинг.

get_capstyle()[source]

Возвращает значение CapStyle.

get_clip_path()[source]

Возвращает путь обрезки в виде (path, transform), где path — экземпляр Path, а transform — аффинное преобразование, применяемое к пути перед обрезкой.

get_clip_rectangle()[source]

Возвращает прямоугольник обрезки как экземпляр Bbox.

get_dashes()[source]

Возвращает стиль штриховки в виде пары (смещение, список штрихов).

Подробности см. в set_dashes.

Значение по умолчанию — (None, None).

get_forced_alpha()[source]

Возвращает значение, определяющее, следует ли использовать значение, возвращённое get_alpha(), для переопределения других значений альфа-канала.

get_gid()[source]

Возвращает идентификатор объекта, если он задан, иначе None.

get_hatch()[source]

Возвращает текущий стиль штриховки.

get_hatch_color()[source]

Возвращает цвет штриховки.

get_hatch_linewidth()[source]

Возвращает толщину линии штриховки.

get_hatch_path(density=6.0)[source]

Возвращает Path для текущей штриховки.

get_joinstyle()[source]

Возвращает значение JoinStyle.

get_linewidth()[source]

Возвращает толщину линии в пунктах.

get_rgb()[source]

Возвращает кортеж из трёх или четырёх чисел с плавающей точкой от 0 до 1.

get_sketch_params()[source]

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

Returns:

tuple или None

Кортеж из 3 элементов:

• scale: Амплитуда колебаний перпендикулярно исходной линии.
• length: Длина колебаний вдоль линии.
• randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Может вернуть None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает установку snap:

• True: вершины привязываются к ближайшему центру пикселя
• False: вершины остаются без изменений
• None: (авто) Если путь содержит только прямолинейные сегменты, они округляются до ближайшего центра пикселя

get_url()[source]

Возвращает URL, если он установлен, иначе None.

restore()[source]

Восстановить графический контекст из стека — необходимо только для тех бэкэндов, которые сохраняют графические контексты в стеке.

set_alpha(alpha)[source]

Установить значение альфа-канала, используемое для смешивания — не поддерживается во всех бэкендах.

Если alpha=None (по умолчанию), компоненты альфа цвета переднего плана и заливки будут использоваться для установки их соответствующей прозрачности (применимо); в противном случае alpha переопределит их.

set_antialiased(b)[source]

Установить, нужно ли рисовать объект с антиалиасингом.

set_capstyle(cs)[source]

Установить способ рисования концов линий.

Параметры:

csCapStyle или {'butt', 'projecting', 'round'}

set_clip_path(path)[source]

Установить область обрезки на TransformedPath или None.

set_clip_rectangle(rectangle)[source]

Установить прямоугольник обрезки на Bbox или None.

set_dashes(dash_offset, dash_list)[source]

Установить стиль пунктирной линии.

Параметры:

dash_offsetfloat

Расстояние в пунктах от начала шаблона пунктирной линии. Обычно устанавливается в 0.

dash_listмассив или None

Последовательность чередования длин штрихов и пробелов в пунктах. None задаёт сплошную линию. Все значения должны быть неотрицательными (\(\ge 0\)).

Примечания

Для более подробной информации см. стр. 666 справочника PostScript Language Reference.

set_foreground(fg, isRGBA=False)[source]

Установить цвет переднего плана.

Параметры:

fgцвет

isRGBAbool

Если известно, что fg является (r, g, b, a) кортежем, isRGBA можно установить в True для повышения производительности.

set_gid(id)[source]

Установить идентификатор.

set_hatch(hatch)[source]

Установить стиль штриховки (для заливки).

set_hatch_color(hatch_color)[source]

Установить цвет штриховки.

set_joinstyle(js)[source]

Установить способ соединения отрезков линий.

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_linewidth(w)[source]

Установить толщину линии в пунктах.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None или не указано, фильтр наброска не будет применён.

lengthfloat, по умолчанию: 128

Длина колебаний вдоль линии в пикселях.

randomnessfloat, по умолчанию: 16

Коэффициент масштабирования, по которому длина сжимается или расширяется.

set_snap(snap)[source]

Установите параметр привязки, который может быть:

• True: привязать вершины к ближайшему центру пикселя
• False: оставить вершины как есть
• None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя

set_url(url)[source]

Установите URL для ссылок в совместимых бэкендах.

classmatplotlib.backend_bases.KeyEvent(name, canvas, key, x=0, y=0, guiEvent=None)[source]

Bases: LocationEvent

Событие нажатия клавиши (ввод, отпускание).

В KeyEvent есть ряд специальных атрибутов помимо тех, которые определены родительскими классами Event и LocationEvent.

Примечания

Ключи модификаторов будут предшествовать нажатой клавише и будут упорядочены «ctrl», «alt», «super». Исключением из этого правила является случай, когда нажатая клавиша сама является клавишей модификатора, поэтому «ctrl+alt» и «alt+control» могут быть допустимыми значениями ключей.

Примеры

def on_key(event):
    print('you pressed', event.key, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('key_press_event', on_key)

Атрибуты:

keyNone или str

Нажатая клавиша(ы). Может быть None, одиночный регистрозависимый символ Unicode («g», «G», «#» и т. д.), специальная клавиша («control», «shift», «f1», «вверх» и т. д.) или комбинация вышеперечисленного (например, «ctrl+alt+g», «ctrl+alt+G»).

classmatplotlib.backend_bases.LocationEvent(name, canvas, x, y, guiEvent=None, *, modifiers=None)[source]

Bases: Event

Событие, имеющее экранное расположение.

В LocationEvent есть ряд специальных атрибутов помимо тех, которые определены родительским классом Event.

Атрибуты:

x, yint или None

Положение события в пикселях от нижнего левого угла холста.

inaxesAxes или None

Объект Axes, над которым находится мышь, если таковой имеется.

xdata, ydatafloat или None

Координаты данных мыши внутри inaxes или None, если мышь не находится над осями.

modifiersfrozenset

Клавиши-модификаторы, которые нажаты в данный момент (за исключением KeyEvent).

lastevent=<matplotlib.backend_bases.MouseEvent object>[source]

classmatplotlib.backend_bases.MouseButton(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

BACK=8[source]

FORWARD=9[source]

LEFT=1[source]

MIDDLE=2[source]

RIGHT=3[source]

classmatplotlib.backend_bases.MouseEvent(name, canvas, x, y, button=None, key=None, step=0, dblclick=False, guiEvent=None, *, modifiers=None)[source]

Bases: LocationEvent

Событие мыши ('button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event').

У объекта MouseEvent есть ряд специальных атрибутов помимо тех, что определены родительскими классами Event и LocationEvent.

Примеры

def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('button_press_event', on_press)

Атрибуты:

buttonNone или MouseButton или {'up', 'down'}

Нажатая кнопка. 'up' и 'down' используются для событий прокрутки.

Обратите внимание, что LEFT и RIGHT фактически относятся к "первичной" и "вторичной" кнопкам, т. е. если пользователь инвертирует свои левую и правую кнопки ("леворукое настройка"), то левая кнопка будет той, что физически находится справа.

Если этот атрибут не задан, name — "scroll_event", и step — ненулевое значение, то он будет установлен на "up" или "down" в зависимости от знака step.

keyNone или str

Нажатая клавиша, когда произошло событие мыши, например, 'shift'. См. KeyEvent.

Предупреждение

В настоящее время эта клавиша извлекается из последнего события 'key_press_event' или 'key_release_event', произошедшего внутри холста. Таким образом, если последнее изменение состояния клавиатуры произошло, когда холст не имел фокуса, этот атрибут будет некорректным. С другой стороны, атрибут modifiers должен всегда быть корректным, но он может сообщать только о модификаторах клавиш.

stepfloat

Количество шагов прокрутки (положительное для 'up', отрицательное для 'down'). Это относится только к 'scroll_event' и по умолчанию равно 0 в других случаях.

dblclickbool

Является ли событие двойным щелчком. Это относится только к 'button_press_event' и по умолчанию ложно в других случаях. В частности, он не используется в 'button_release_event'.

classmatplotlib.backend_bases.NavigationToolbar2(canvas)[source]

Bases: object

Базовый класс для навигационного курсора, версия 2.

Модули должны реализовывать холст, который обрабатывает подключения для 'button_press_event' и 'button_release_event'. См. FigureCanvasBase.mpl_connect() для получения дополнительной информации.

Они также должны определить

save_figure()

сохранить текущую фигуру

draw_rubberband() (необязательно)

нарисовать прямоугольник "резинка" для масштабирования по прямоугольнику

set_message() (необязательно)

отобразить сообщение

set_history_buttons() (необязательно)

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

и переопределить __init__ для настройки панели инструментов — не забывая вызвать init базового класса. Как правило, __init__ необходимо настроить кнопки панели инструментов, связанные с методами home, back, forward, pan, zoom и save_figure, используя стандартные значки в подкаталоге "images" пути к данным.

Вот и все, остальное мы сделаем!

back(*args)[source]

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

Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.

configure_subplots(*args)[source]

drag_pan(event)[source]

Обратный вызов для перетаскивания в режиме панорамирования/масштабирования.

drag_zoom(event)[source]

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

draw_rubberband(event, x0, y0, x1, y1)[source]

Отрисовка прямоугольника резинки для обозначения границ масштабирования.

Обратите внимание, что не гарантируется, что x0 <= x1 и y0 <= y1.

forward(*args)[source]

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

Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.

home(*args)[source]

Восстановить исходный вид.

Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.

mouse_move(event)[source]

pan(*args)[source]

Переключить инструмент панорамирования/масштабирования.

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

press_pan(event)[source]

Обратный вызов для нажатия кнопки мыши в режиме панорамирования/масштабирования.

press_zoom(event)[source]

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

push_current()[source]

Поместить текущие пределы просмотра и положение в стек.

release_pan(event)[source]

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

release_zoom(event)[source]

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

remove_rubberband()[source]

Удалить резинку.

save_figure(*args)[source]

Сохранить текущий рисунок.

set_history_buttons()[source]

Включить или выключить кнопки "Назад"/ "Вперёд".

set_message(s)[source]

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

toolitems=(('Главная', 'Сбросить исходный вид', 'home', 'home'), ('Назад', 'Возврат к предыдущему виду', 'back', 'back'), ('Вперёд', 'Переход к следующему виду', 'forward', 'forward'), (None, None, None, None), ('Перемещение', 'Левая кнопка мыши для перемещения, правая кнопка для масштабирования\nx/y фиксируют ось, CTRL фиксирует аспект', 'move', 'pan'), ('Масштабирование', 'Масштабирование по прямоугольнику\nx/y фиксируют ось', 'zoom_to_rect', 'zoom'), ('Подграфики', 'Настройка подграфиков', 'subplots', 'configure_subplots'), (None, None, None, None), ('Сохранить', 'Сохранить рисунок', 'filesave', 'save_figure'))

update()[source]

Сбросить стек осей.

zoom(*args)[source]

exceptionmatplotlib.backend_bases.NonGuiException[source]

Bases: Exception

Вызывается при попытке показать рисунок в бэкенде без графического интерфейса.

classmatplotlib.backend_bases.PickEvent(name, canvas, mouseevent, artist, guiEvent=None, **kwargs)[source]

Bases: Event

Событие выбора.

Это событие генерируется, когда пользователь выбирает положение на холсте, достаточно близкое к элементу, который был сделан выбираемым с помощью Artist.set_picker.

У события PickEvent есть ряд специальных атрибутов помимо тех, которые определены в родительском классе Event.

Примеры

Свяжите функцию on_pick() с событиями выбора, чтобы выводить координаты выбранной точки данных:

ax.plot(np.rand(100), 'o', picker=5)  # 5 points tolerance

def on_pick(event):
    line = event.artist
    xdata, ydata = line.get_data()
    ind = event.ind
    print(f'on pick line: {xdata[ind]:.3f}, {ydata[ind]:.3f}')

cid = fig.canvas.mpl_connect('pick_event', on_pick)

Атрибуты:

mouseeventMouseEvent

Событие мыши, которое сгенерировало выбор.

artistArtist

Выбранный элемент. Обратите внимание, что элементы по умолчанию не выбираются (см. Artist.set_picker).

other

В зависимости от типа выбранного объекта могут присутствовать дополнительные атрибуты; например, выбор Line2D может определять разные дополнительные атрибуты, чем выбор PatchCollection.

classmatplotlib.backend_bases.RendererBase[source]

Основания: object

Абстрактный базовый класс для обработки операций рисования/рендеринга.

Для полной функциональности следующие методы должны быть реализованы в бэкенде (хотя только реализация draw_path уже обеспечит весьма функциональный бэкенд):

• draw_path
• draw_image
• draw_gouraud_triangles

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

• draw_text
• draw_markers
• draw_path_collection
• draw_quad_mesh

close_group(s)[source]

Закрыть элемент группировки с меткой s.

Используется только рендерером SVG.

draw_gouraud_triangle(gc, points, colors, transform)[source]

[Устарело] Отрисовка треугольника с интерполяцией цвета Гуро.

Параметры:

gcGraphicsContextBase

Контекст графики.

points(3, 2) массив-подобный

Массив точек (x, y) для треугольника.

colors(3, 4) массив-подобный

Цвета RGBA для каждой точки треугольника.

transformTransform

Аффинное преобразование, применяемое к точкам.

Замечания

Устарело начиная с версии 3.7: Используйте draw_gouraud_triangles вместо этого.

draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[source]

Отрисовка ряда треугольников с интерполяцией цвета Гуро.

Параметры:

gcGraphicsContextBase

Контекст графики.

triangles_array(N, 3, 2) массив-подобный

Массив из N точек (x, y) для треугольников.

colors_array(N, 3, 4) массив-подобный

Массив из N цветов RGBA для каждой точки треугольников.

transformTransform

Аффинное преобразование, применяемое к точкам.

draw_image(gc, x, y, im, transform=None)[source]

Отрисовка RGBA изображения.

Параметры:

gcGraphicsContextBase

Контекст графики с информацией о обрезке.

xскаляр

Расстояние в физических единицах (т.е., точки или пиксели) от левой стороны холста.

yскаляр

Расстояние в физических единицах (т.е., точки или пиксели) от нижней стороны холста.

im(N, M, 4) массив-подобный типа np.uint8

Массив пикселей RGBA.

transformmatplotlib.transforms.Affine2DBase

Если и только если конкретный бэкенд написан так, что option_scale_image возвращает True, может быть передано аффинное преобразование (т.е., Affine2DBase) может быть передано в draw_image. Вектор переноса преобразования задается в физических единицах (т.е., точки или пиксели). Обратите внимание, что преобразование не переопределяет x и y и должно быть применено перед переносом результата на x и y (это можно сделать, добавив x и y к вектору переноса, определенному transform).

draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]

Отрисовка маркера в каждой вершине пути path (исключая контрольные точки).

Базовая (fallback) реализация выполняет несколько вызовов draw_path. Бэкенды могут переопределить этот метод, чтобы нарисовать маркер только один раз и использовать его многократно.

Параметры:

gcGraphicsContextBase

Контекст графики.

marker_transTransform

Аффинное преобразование, применяемое к маркеру.

transTransform

Аффинное преобразование, применяемое к пути.

draw_path(gc, path, transform, rgbFace=None)[source]

Отрисовка экземпляра Path с использованием заданного аффинного преобразования.

draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offset_trans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[source]

Отрисовка коллекции paths.

Каждый путь сначала преобразуется с помощью соответствующей записи в all_transforms (список матриц 3x3), а затем — с помощью master_transform. Затем они сдвигаются на соответствующую запись в offsets, которая предварительно преобразуется с помощью offset_trans.

facecolors, edgecolors, linewidths, linestyles и antialiased — списки, задающие соответствующие свойства.

offset_position сейчас не используется, но аргумент сохраняется для обратной совместимости.

Базовая (fallback) реализация делает несколько вызовов draw_path. Бэкэнды могут переопределить этот метод, чтобы отрисовать каждый набор данных путей только один раз, а затем ссылаться на этот путь несколько раз с различными смещениями, цветами, стилями и т.д. Методы-генераторы _iter_collection_raw_paths и _iter_collection предназначены для помощи (и стандартизации) реализации в разных бэкендах. Настоятельно рекомендуется использовать эти генераторы, чтобы изменения в поведении draw_path_collection можно было вносить глобально.

draw_quad_mesh(gc, master_transform, meshWidth, meshHeight, coordinates, offsets, offsetTrans, facecolors, antialiased, edgecolors)[source]

Отрисовка сетки из четырёхугольников.

Базовая (fallback) реализация преобразует сетку четырёхугольников в пути и затем вызывает draw_path_collection.

draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]

Отрисовка TeX-экземпляра.

Параметры:

gcGraphicsContextBase

Контекст графики.

xfloat

Положение x текста в координатах отображения.

yfloat

Положение y базовой линии текста в координатах отображения.

sstr

Строка TeX-текста.

propFontProperties

Свойства шрифта.

anglefloat

Угол поворота в градусах против часовой стрелки.

mtextText

Исходный объект текста для отрисовки.

draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]

Отрисовка экземпляра текста.

Параметры:

gcGraphicsContextBase

Контекст графики.

xfloat

Положение x текста в координатах отображения.

yfloat

Положение y базовой линии текста в координатах отображения.

sstr

Строка текста.

propFontProperties

Свойства шрифта.

anglefloat

Угол поворота в градусах против часовой стрелки.

ismathbool or "TeX"

Если True, используется парсер mathtext. Если "TeX", используется TeX для отрисовки.

mtextText

Исходный объект текста для отрисовки.

Примечания

Примечание для разработчиков бэкендов:

При попытке определить, правильно ли вы рассчитали область обрезки (что необходимо для корректного выравнивания и расположения текста), полезно изменить строку в text.py:

if 0: bbox_artist(self, renderer)

на if 1, тогда вместе с текстом будет нарисована и область обрезки.

flipy()[source]

Возвращает, увеличиваются ли значения y сверху вниз.

Обратите внимание, что это влияет только на отрисовку текста.

get_canvas_width_height()[source]

Возвращает ширину и высоту холста в координатах отображения.

get_image_magnification()[source]

Получить коэффициент увеличения изображений, передаваемых в draw_image. Позволяет бэкенду иметь изображения с другим разрешением по сравнению с другими элементами.

get_texmanager()[source]

Возвращает экземпляр TexManager.

get_text_width_height_descent(s, prop, ismath)[source]

Получить ширину, высоту и спуск (смещение снизу до базовой линии) в координатах отображения строки s с FontProperties prop.

new_gc()[source]

Возвращает экземпляр GraphicsContextBase.

open_group(s, gid=None)[source]

Открывает элемент группировки с меткой s и gid (если задано) в качестве идентификатора.

Используется только рендерером SVG.

option_image_nocomposite()[source]

Возвращает, нужно ли пропускать композицию изображений Matplotlib.

Векторные бэкэнды обычно должны возвращать not rcParams["image.composite_image"]. Растровые бэкэнды обычно должны возвращать False (позволяя C-уровневому растрирователю позаботиться о композиции изображений).

option_scale_image()[source]

Возвращает, поддерживаются ли произвольные аффинные преобразования в draw_image (True для большинства векторных бэкэндов).

points_to_pixels(points)[source]

Преобразовать точки в единицы отображения.

Вам нужно переопределить эту функцию (если ваш бэкенд не имеет dpi, например, postscript или svg). Некоторые системы отображения предполагают некоторое значение для пикселей на дюйм:

points to pixels = points * pixels_per_inch/72 * dpi/72

Parameters:

pointsfloat или array-like

значение с плавающей точкой или массив NumPy с плавающей точкой

Returns:

Преобразованные в пиксели точки

start_filter()[source]

Переключается на временный рендер для эффектов фильтрации изображений.

В настоящее время поддерживается только рендерером agg.

start_rasterizing()[source]

Переключается на растровый рендер.

Используется MixedModeRenderer.

stop_filter(filter_func)[source]

Возвращается к исходному рендеру. Содержимое временного рендера обрабатывается с помощью filter_func и отображается на исходном рендере в виде изображения.

В настоящее время поддерживается только рендерером agg.

stop_rasterizing()[source]

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

Используется MixedModeRenderer.

classmatplotlib.backend_bases.ResizeEvent(name, canvas)[source]

Bases: Event

Событие, срабатывающее при изменении размера холста.

ResizeEvent имеет ряд специальных атрибутов помимо тех, которые определены родительским классом Event.

Attributes:

widthint

Ширина холста в пикселях.

heightint

Высота холста в пикселях.

classmatplotlib.backend_bases.ShowBase[source]

Bases: _Backend

Простой базовый класс для генерации функции show() в бэкендах.

Подкласс должен переопределить метод mainloop().

classmatplotlib.backend_bases.TimerBase(interval=None, callbacks=None)[source]

Bases: object

Базовый класс для предоставления таймерных событий, полезных для анимаций. Бэкэндам необходимо реализовать несколько специфических методов, чтобы использовать собственные механизмы тайминга таким образом, чтобы таймерные события были интегрированы в их циклы обработки событий.

Подклассы должны переопределить следующие методы:

• _timer_start: Специфичный для бэкэнда код для запуска таймера.
• _timer_stop: Специфичный для бэкэнда код для остановки таймера.

Подклассы могут дополнительно переопределить следующие методы:

• _timer_set_single_shot: Код для установки таймера в режим однократного запуска, если это поддерживается объектом таймера. Если нет, класс Timer сам сохранит флаг, а метод _on_timer должен быть переопределен для поддержки такого поведения.
• _timer_set_interval: Код для установки интервала таймера, если для объекта таймера есть такой метод.
• _on_timer: Внутренняя функция, которую должен вызывать любой объект таймера, которая будет обрабатывать задачу запуска всех установленных обратных вызовов.

Параметры:

intervalint, по умолчанию: 1000мс

Время между таймерными событиями в миллисекундах. Будет храниться как timer.interval.

callbackslist[tuple[callable, tuple, dict]]

Список кортежей (func, args, kwargs), которые будут вызываться при таймерных событиях. Этот список доступен как timer.callbacks и может быть изменён напрямую, или для этого можно использовать функции add_callback и remove_callback.

add_callback(func, *args, **kwargs)[source]

Регистрирует func для вызова таймером при срабатывании события. Любые дополнительные аргументы, предоставленные, будут переданы в func.

Эта функция возвращает func, что позволяет использовать её как декоратор.

свойствоinterval

Время между таймерными событиями в миллисекундах.

remove_callback(func, *args, **kwargs)[source]

Удаляет func из списка обратных вызовов.

args и kwargs являются необязательными и используются для различения копий одной и той же функции, зарегистрированной для вызова с разными аргументами. Это поведение устарело. В будущем *args, **kwargs больше не будет учитываться; чтобы сохранить возможность удаления определенного обратного вызова, передайте его в add_callback как объект functools.partial.

свойствоsingle_shot

Определяет, должен ли этот таймер останавливаться после одного запуска.

start(interval=None)[source]

Запустить объект таймера.

Параметры:

intervalint, необязательно

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

stop()[source]

Остановить таймер.

classmatplotlib.backend_bases.ToolContainerBase(toolmanager)[source]

Bases: object

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

Атрибуты:

toolmanagerToolManager

Инструменты, с которыми этот ToolContainer хочет взаимодействовать.

add_tool(tool, group, position=-1)[source]

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

Параметры:

tooltool_like

Инструмент для добавления, см. ToolManager.get_tool.

groupstr

Название группы, в которую нужно добавить этот инструмент.

positionint, по умолчанию: -1

Позиция в группе для размещения этого инструмента.

add_toolitem(name, group, position, image, description, toggle)[source]

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

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

Обработчик события щелчка по кнопке обязательно должен быть self.trigger_tool(name).

Параметры:

namestr

Имя добавляемого инструмента, используется в качестве идентификатора инструмента и по умолчанию как метка кнопок.

groupstr

Название группы, к которой относится этот инструмент.

positionint

Позиция инструмента в группе, если -1, то он добавляется в конец.

imagestr

Имя файла изображения для кнопки или None.

descriptionstr

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

togglebool

• True : Кнопка является переключателем (изменение состояния нажатия/отжатия между последовательными нажатиями).
• False : Кнопка является обычной кнопкой (возвращается в состояние отжатия после отпускания).

remove_toolitem(name)[source]

Удалить элемент инструмента из ToolContainer.

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

Вызывается, когда ToolManager генерирует событие tool_removed_event.

Параметры:

namestr

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

set_message(s)[source]

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

Параметры:

sstr

Текст сообщения.

toggle_toolitem(name, toggled)[source]

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

Параметры:

namestr

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

toggledbool

Установить этот инструмент в состояние включения или выключения.

trigger_tool(name)[source]

Запустить инструмент.

Параметры:

namestr

Имя (идентификатор) инструмента, запущенного из контейнера.

matplotlib.backend_bases.button_press_handler(event, canvas=None, toolbar=None)[source]

Стандартные действия Matplotlib для дополнительных кнопок мыши.

Параметры аналогичны key_press_handler, за исключением того, что event — это MouseEvent.

matplotlib.backend_bases.get_registered_canvas_class(format)[source]

Возвращает зарегистрированный по умолчанию холст для данного формата файла. Обрабатывает отложенный импорт необходимого бэкэнда.

matplotlib.backend_bases.key_press_handler(event, canvas=None, toolbar=None)[source]

Реализует стандартные привязки клавиш Matplotlib для холста и панели инструментов, описанные в Клавиши быстрого доступа для навигации.

Параметры:

eventKeyEvent

Событие нажатия/отпускания клавиши.

canvasFigureCanvasBase, значение по умолчанию: event.canvas

Экземпляр холста, специфичный для бэкэнда. Этот параметр сохраняется для обратной совместимости, но, если задан, всегда должен быть равен event.canvas.

toolbarNavigationToolbar2, значение по умолчанию: event.canvas.toolbar

Панель инструментов навигации. Этот параметр сохраняется для обратной совместимости, но, если задан, всегда должен быть равен event.canvas.toolbar.

matplotlib.backend_bases.register_backend(format, backend, description=None)[source]

Регистрирует бэкэнд для сохранения в заданный формат файла.

Параметры:

formatstr

Расширение файла

backendстрока модуля или класс холста

Бэкэнд для обработки вывода в файл

descriptionстрока, значение по умолчанию: ""

Описание типа файла.