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

Поверхность холста, в которую рисуется фигура. Вызывает методы draw и print fig, создаёт рендеры и т.д.

Примечание: шаблоны GUI должны подключать события нажатия кнопок, перемещения мыши и нажатия клавиш к функциям, которые вызывают базовые методы button_press_event, button_release_event, motion_notify_event, key_press_event и key_release_event. Примеры см. в реализациях интерактивных бэкендов.

Атрибуты:

figurematplotlib.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, *args, **kwargs)[source]

Запись в формате foo.

Этот метод обычно вызывается через Figure.savefig и FigureCanvasBase.print_figure, которые позаботятся о настройке цвета фона фигуры, цвета рамки и dpi для желаемых значений вывода и восстановят их к исходным значениям. Поэтому, print_foo не нужно обрабатывать эти настройки.

matplotlib.backends.backend_template.FigureManager[source]

псевдоним FigureManagerTemplate

classmatplotlib.backends.backend_template.FigureManagerTemplate(canvas, num)[source]

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

Вспомогательный класс для режима pyplot, объединяющий всё в аккуратный пакет.

Для неинтерактивных бэкендов достаточно базового класса.

classmatplotlib.backends.backend_template.GraphicsContextTemplate[source]

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

Контекст графики предоставляет цвет, стили линий и т.д. Примеры отображения атрибутов контекста графики (стилей обрезки, соединения, ширины линий, цветов) в определённом бэкенде см. в бэкендах cairo и postscript. В cairo это делается путём обертывания объекта cairo.Context и перенаправления соответствующих вызовов к нему с использованием словаря, сопоставляющего стили с константами gdk. В Postscript вся работа выполняется рендерером, сопоставляющим стили линий с вызовами Postscript.

Если более уместно выполнять сопоставление на уровне рендерера (как в бэкенде Postscript), вам не нужно переопределять методы GC. Если более уместно обернуть экземпляр (как в бэкенде cairo) и выполнить сопоставление здесь, вам нужно переопределить несколько методов-сеттеров.

В базовом контексте графики цвета хранятся как кортеж 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.

Parameters:

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_path(gc, path, transform, rgbFace=None)[source]

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

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

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

Parameters:

gcGraphicsContextBase

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

xfloat

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

yfloat

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

sstr

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

propmatplotlib.font_manager.FontProperties

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

anglefloat

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

mtextmatplotlib.text.Text

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

Примечания

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

Когда вы пытаетесь определить, правильно ли вы рассчитали прямоугольник (что позволяет правильно выполнить выравнивание текста), полезно изменить строку в 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 со свойствами шрифта FontProperties prop.

new_gc()[source]

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

points_to_pixels(points)[source]

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

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

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

Parameters:

pointsfloat или массив-подобный

float или numpy массив float

Returns:

Точки, преобразованные в пиксели

matplotlib.backends.backend_template.show(*, block=None)[source]

Для графических backends - не требуется. Для GUI backends - show() обычно является последней строкой скрипта pyplot и сообщает backend о том, что пора рисовать. В интерактивном режиме это ничего не должно делать.