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 -
псевдоним для
matplotlib.backends.backend_template.FigureCanvasTemplate
- класс
matplotlib.backends.backend_template.FigureCanvasTemplate(figure=None)[source] -
Базы:
matplotlib.backend_bases.FigureCanvasBaseПоверхность холста, на которую отрисовывается фигура. Вызывает методы draw и print fig, создаёт рендереры и т.д.
Примечание: Шаблоны GUI должны подключать события для нажатий кнопок, перемещения мыши и нажатия клавиш к функциям, которые вызывают методы базового класса button_press_event, button_release_event, motion_notify_event, key_press_event и key_release_event. Примеры см. в реализациях интерактивных бэкэндов.
Атрибуты: -
figure
matplotlib.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'}
-
get_default_filetype()[source] -
Возвращает формат файла сохранения по умолчанию, как указано в
rcParams["savefig.format"](по умолчанию:'png').Возвращаемая строка не содержит точки. Этот метод переопределяется в бэкендах, которые поддерживают только один тип файла.
-
print_foo(filename, *args, **kwargs)[source] -
Запись формата foo.
Этот метод обычно вызывается через
Figure.savefigиFigureCanvasBase.print_figure, которые заботятся о настройке цвета фона фигуры, цвета обводки и dpi на желаемые значения вывода и восстановят их к исходным значениям. Поэтому,print_fooне нужно обрабатывать эти настройки.
-
figure
-
matplotlib.backends.backend_template.FigureManager -
псевдоним для
matplotlib.backends.backend_template.FigureManagerTemplate
- класс
matplotlib.backends.backend_template.FigureManagerTemplate(canvas, num)[source] -
Базы:
matplotlib.backend_bases.FigureManagerBaseВспомогательный класс для режима pyplot, объединяет всё в аккуратный пакет.
Для неинтерактивных бэкэндов достаточно базового класса.
- класс
matplotlib.backends.backend_template.GraphicsContextTemplate[source] -
Базы:
matplotlib.backend_bases.GraphicsContextBaseГрафический контекст предоставляет цвет, стили линий и т.д. ... Примеры сопоставления атрибутов графического контекста (стили концов, стили соединения, ширина линий, цвета) с определённым бэкэндом см. в бэкэндах cairo и postscript. В cairo это делается путём обертывания объекта cairo.Context и перенаправления соответствующих вызовов к нему с помощью словаря, сопоставляющего стили с константами gdk. В Postscript вся работа выполняется рендерером, сопоставляющим стили линий с вызовами Postscript.
Если более уместно выполнить сопоставление на уровне рендерера (как в бэкэнде Postscript), вам не нужно переопределять ни один из методов GC. Если более уместно обернуть экземпляр (как в бэкэнде cairo) и выполнить сопоставление здесь, вам нужно будет переопределить несколько методов установки.
В базовом GraphicsContext цвета хранятся в виде кортежа RGB на единичном интервале, например, (0,5, 0,0, 1,0). Возможно, вам потребуется преобразовать это в цвета, подходящие для вашего бэкэнда.
- class
matplotlib.backends.backend_template.RendererTemplate(dpi)[source] -
Bases:
matplotlib.backend_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
matplotlib.font_manager.FontProperties -
Свойства шрифта.
- anglefloat
-
Угол поворота в градусах против часовой стрелки.
-
mtext
matplotlib.text.Text -
Исходный объект текста, подлежащий рендерингу.
Примечания
Примечание для разработчиков бэкэндов:
При попытке определить, правильно ли вы получили прямоугольник (что позволяет корректно работать с выравниванием/выкладкой текста), полезно изменить строку в файле text.py:
if 0: bbox_artist(self, renderer)
на if 1, и тогда прямоугольник будет отображаться вместе с текстом.
-
gc
-
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
Возвращает: - Точки, преобразованные в пиксели
-
-
matplotlib.backends.backend_template.draw_if_interactive()[source] -
Для бэкэндов изображений - не требуется. Для бэкэндов графического интерфейса - это нужно переопределить, если рисование должно выполняться в интерактивном режиме Python.
-
matplotlib.backends.backend_template.new_figure_manager(num, *args, FigureClass=<class 'matplotlib.figure.Figure'>, **kwargs)[source] -
Создать новый экземпляр менеджера фигур.
-
matplotlib.backends.backend_template.new_figure_manager_given_figure(num, figure)[source] -
Создать новый экземпляр менеджера фигур для заданной фигуры.
-
matplotlib.backends.backend_template.show(*, block=None)[source] -
Для backends изображений — не требуется. Для backends графического интерфейса — show() обычно является последней строкой скрипта pyplot и сообщает backend, что пришло время рисовать. В интерактивном режиме это ничего не должно делать.
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/backend_template_api.html