matplotlib.backends.backend_template
Полностью функциональный, ничего не делающий бэкэнд, предназначенный в качестве шаблона для авторов бэкэндов. Он полностью функционален в том смысле, что вы можете выбрать его как бэкэнд, например, с помощью
import matplotlib
matplotlib.use("template")
и ваша программа (должна!) выполнится без ошибок, хотя вывод не будет произведён. Это даёт отправную точку для авторов бэкэндов; вы можете выборочно реализовать методы рисования (draw_path, draw_image и т.д.) и постепенно наблюдать, как ваша фигура оживает, вместо того, чтобы иметь полную реализацию, прежде чем получить какие-либо результаты.
Скопируйте этот файл в каталог вне дерева исходного кода Matplotlib, в место, где Python может его импортировать (добавив каталог в ваш sys.path или упаковав его как обычный пакет Python); если бэкэнд импортируется как import my.backend, вы можете затем выбрать его с помощью
import matplotlib
matplotlib.use("module://my.backend")
Если ваш бэкэнд реализует поддержку сохранения фигур (т.е. имеет метод print_xyz), вы можете зарегистрировать его как обработчик по умолчанию для данного типа файла:
from matplotlib.backend_bases import register_backend
register_backend('xyz', 'my_backend', 'XYZ File Format')
...
plt.savefig("figure.xyz")
- matplotlib.backends.backend_template.FigureCanvas[source]
-
псевдоним
FigureCanvasTemplate
- classmatplotlib.backends.backend_template.FigureCanvasTemplate(figure=None)[source]
-
Базы:
FigureCanvasBaseПоверхность холста, на которую рисуется фигура. Вызывает методы рисования и печати фигуры, создаёт рендереры и т.д.
Примечание: шаблоны GUI должны подключать события для нажатий кнопок, перемещений мыши и нажатий клавиш к функциям, которые вызывают методы базового класса button_press_event, button_release_event, motion_notify_event, key_press_event и key_release_event. См. реализации интерактивных бэкэндов для примеров.
- Атрибуты:
-
-
figure
Figure -
Экземпляр объекта Figure высокого уровня
-
figure
- draw()[source]
-
Отрисовка фигуры с помощью рендерера.
Важно, чтобы этот метод фактически проходил по дереву элементов, даже если вывод не производится, поскольку это запускает отложенную работу (например, вычисление автопределов и значений делений), к которой пользователи могут получить доступ перед сохранением на диск.
- filetypes={'eps': 'Encapsulated Postscript', 'foo': 'Мой волшебный формат Foo', 'jpeg': 'Joint Photographic Experts Group', 'jpg': 'Joint Photographic Experts Group', 'pdf': 'Portable Document Format', 'pgf': 'PGF-код для LaTeX', 'png': 'Portable Network Graphics', 'ps': 'Postscript', 'raw': 'Растровый RGBA-битовый массив', 'rgba': 'Растровый RGBA-битовый массив', 'svg': 'Scalable Vector Graphics', 'svgz': 'Scalable Vector Graphics', 'tif': 'Tagged Image File Format', 'tiff': 'Tagged Image File Format', 'webp': 'WebP Image Format'}
- get_default_filetype()[source]
-
Возвращает формат файла сохранения по умолчанию, указанный в
rcParams["savefig.format"](по умолчанию:'png').Возвращаемая строка не включает точку. Этот метод переопределяется в бэкэндах, которые поддерживают только один тип файла.
- manager_class[source]
-
псевдоним
FigureManagerTemplate
- print_foo(filename, **kwargs)[source]
-
Запись формата foo.
Этот метод обычно вызывается через
Figure.savefigиFigureCanvasBase.print_figure, которые заботятся о настройке цвета лицевой стороны фигуры, цвета грани и разрешения на желаемые выходные значения и вернут их к исходным значениям. Поэтомуprint_fooне нужно обрабатывать эти настройки.
- matplotlib.backends.backend_template.FigureManager[source]
-
псевдоним
FigureManagerTemplate
- classmatplotlib.backends.backend_template.FigureManagerTemplate(canvas, num)[source]
-
Базы:
FigureManagerBaseВспомогательный класс для режима pyplot, объединяет всё в удобный пакет.
Для неинтерактивных бэкэндов достаточно базового класса. Для интерактивных бэкэндов см. документацию класса
FigureManagerBaseдля списка методов, которые можно/следует переопределить.
- classmatplotlib.backends.backend_template.GraphicsContextTemplate[source]
-
Базы:
GraphicsContextBaseКонтекст графики предоставляет цвет, стили линий и т.д. См. бэкэнды cairo и postscript для примеров сопоставления атрибутов контекста графики (стили концов, стили соединения, ширина линий, цвета) с конкретным бэкэндом. В cairo это делается путём обертывания объекта cairo.Context и перенаправления соответствующих вызовов на него с помощью словаря, отображающего стили на константы gdk. В Postscript вся работа выполняется рендерером, сопоставляющим стили линий с вызовами Postscript.
Если более уместно выполнять сопоставление на уровне рендерера (как в бэкэнде Postscript), вам не нужно переопределять какие-либо методы GC. Если более уместно обернуть экземпляр (как в бэкэнде cairo) и выполнить сопоставление здесь, вам нужно будет переопределить несколько методов-установщиков.
Базовый GraphicsContext хранит цвета как кортеж RGB в единичном интервале, например (0,5, 0,0, 1,0). Вам может потребоваться отобразить это на цвета, соответствующие вашему бэкэнду.
- classmatplotlib.backends.backend_template.RendererTemplate(dpi)[source]
-
Bases:
RendererBaseОтображатель обрабатывает операции рисования/рендеринга.
Это минимальный класс без действий, который можно использовать для начала работы при написании нового бэкэнда. Обратитесь к
backend_bases.RendererBaseдля документации по методам.- draw_image(gc, x, y, im)[source]
-
Отобразить RGBA изображение.
- Параметры:
-
-
gc
GraphicsContextBase -
Контекст графики с информацией о обрезке.
- xскаляр
-
Расстояние в физических единицах (т.е. точки или пиксели) от левой стороны холста.
- yскаляр
-
Расстояние в физических единицах (т.е. точки или пиксели) от нижней стороны холста.
- im(N, M, 4) массив-подобный np.uint8
-
Массив RGBA пикселей.
-
transform
matplotlib.transforms.Affine2DBase -
Если и только если конкретный бэкэнд написан таким образом, что
option_scale_imageвозвращаетTrue, аффинное преобразование (т.е.Affine2DBase) может быть передано вdraw_image. Вектор переноса преобразования задается в физических единицах (т.е. точках или пикселях). Обратите внимание, что преобразование не переопределяет x и y и должно быть применено перед переводом результата на x и y (это можно сделать, добавив x и y в вектор переноса, определенный transform).
-
gc
- draw_path(gc, path, transform, rgbFace=None)[source]
-
Отобразить экземпляр
Pathс заданным афинным преобразованием.
- draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
-
Отобразить экземпляр текста.
- Параметры:
-
-
gc
GraphicsContextBase -
Контекст графики.
- xfloat
-
Координата x текста в координатах отображения.
- yfloat
-
Координата y базовой линии текста в координатах отображения.
- sstr
-
Строка текста.
-
prop
FontProperties -
Свойства шрифта.
- anglefloat
-
Угол поворота в градусах против часовой стрелки.
- ismathbool or "TeX"
-
Если True, используйте математический парсер. Если "TeX", используйте tex для рендеринга.
-
mtext
Text -
Исходный объект текста для рендеринга.
-
gc
Примечания
Примечание для разработчиков бэкэндов:
Когда вы пытаетесь определить, правильно ли вы рассчитали прямоугольник обводки (что позволяет правильно настроить текст по вертикали/горизонтали), это помогает изменить строку в text.py:
if 0: bbox_artist(self, renderer)
на if 1, и тогда фактический прямоугольник обводки будет отображаться вместе с вашим текстом.
- flipy()[source]
-
Возвращает, увеличиваются ли значения y сверху вниз.
Обратите внимание, что это влияет только на отображение текста.
- get_canvas_width_height()[source]
-
Возвращает ширину и высоту холста в координатах отображения.
- get_text_width_height_descent(s, prop, ismath)[source]
-
Получить ширину, высоту и спуск (смещение снизу до базовой линии) в координатах отображения строки s с
FontPropertiesprop.
- new_gc()[source]
-
Возвращает экземпляр
GraphicsContextBase.
- points_to_pixels(points)[source]
-
Преобразовать точки в единицы отображения.
Вам нужно переопределить эту функцию (если ваш бэкэнд не имеет dpi, например, postscript или svg). Некоторые системы обработки изображений предполагают какое-то значение для пикселей на дюйм:
points to pixels = points * pixels_per_inch/72 * dpi/72
- Параметры:
-
- pointsfloat или массив-подобный
-
float или numpy массив float
- Возвращает:
-
- Точки, преобразованные в пиксели
© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.7.5/api/backend_template_api.html