matplotlib.backends.backend_pdf

Модуль matplotlib для вывода в PDF. Автор: Jouni K Seppänen <jks@iki.fi>

matplotlib.backends.backend_pdf.FigureCanvas

Псевдоним для matplotlib.backends.backend_pdf.FigureCanvasPdf

class matplotlib.backends.backend_pdf.FigureCanvasPdf(figure) [source]

Базовый класс: matplotlib.backend_bases.FigureCanvasBase

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

Атрибуты:	figurematplotlib.figure.Figure Объект Figure высокого уровня

draw(self) [source]

Отрисовка Figure.

filetypes = {'pdf': 'Portable Document Format'}

fixed_dpi = 72

get_default_filetype(self) [source]

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

print_pdf(self, filename, *, dpi=72, bbox_inches_restore=None, metadata=None, **kwargs) [source]

class matplotlib.backends.backend_pdf.GraphicsContextPdf(file) [source]

Базовый класс: matplotlib.backend_bases.GraphicsContextBase

alpha_cmd(self, alpha, forced, effective_alphas) [source]

capstyle_cmd(self, style) [source]

capstyles = {'butt': 0, 'projecting': 2, 'round': 1}

clip_cmd(self, cliprect, clippath) [source]

Устанавливает прямоугольник обрезки. Вызывает self.pop() и self.push().

commands = ((('_cliprect', '_clippath'), <function GraphicsContextPdf.clip_cmd>), (('_alpha', '_forced_alpha', '_effective_alphas'), <function GraphicsContextPdf.alpha_cmd>), (('_capstyle',), <function GraphicsContextPdf.capstyle_cmd>), (('_fillcolor',), <function GraphicsContextPdf.fillcolor_cmd>), (('_joinstyle',), <function GraphicsContextPdf.joinstyle_cmd>), (('_linewidth',), <function GraphicsContextPdf.linewidth_cmd>), (('_dashes',), <function GraphicsContextPdf.dash_cmd>), (('_rgb',), <function GraphicsContextPdf.rgb_cmd>), (('_hatch', '_hatch_color'), <function GraphicsContextPdf.hatch_cmd>))

copy_properties(self, other) [source]

Копирует свойства из другого объекта в текущий.

dash_cmd(self, dashes) [source]

delta(self, other) [source]

Копирует свойства из другого объекта в текущий и возвращает команды PDF, необходимые для преобразования текущего объекта в другой.

fill(self, *args) [source]

Проверка: нужно ли заполнять путь?

Дополнительный аргумент может быть использован для указания альтернативного _fillcolor, как это необходимо для RendererPdf.draw_markers.

fillcolor_cmd(self, rgb) [source]

finalize(self) [source]

Убедитесь, что каждый вложенный графический контекст закрыт.

hatch_cmd(self, hatch, hatch_color) [source]

joinstyle_cmd(self, style) [source]

joinstyles = {'bevel': 2, 'miter': 0, 'round': 1}

linewidth_cmd(self, width) [source]

paint(self) [source]

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

pop(self) [source]

push(self) [source]

rgb_cmd(self, rgb) [source]

stroke(self) [source]

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

class matplotlib.backends.backend_pdf.Name(name) [source]

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

Объект имени PDF.

static hexify(match) [source]

name

pdfRepr(self) [source]

class matplotlib.backends.backend_pdf.Operator(op) [source]

Базы: object

Объект оператора PDF.

op

pdfRepr(self) [source]

class matplotlib.backends.backend_pdf.PdfFile(filename, metadata=None) [source]

Базы: object

Объект файла PDF.

Параметры:

filenamestr or path-like or file-like Целевой объект вывода; если строка, будет открыт файл для записи. metadatadict from strings to strings and dates Объект словаря информации (см. раздел 10.2.1 'Документ Словарь информации' справочника PDF), например: {'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome fig'}. Стандартные ключи: 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producer', 'CreationDate', 'ModDate', и 'Trapped'. Значения определены для 'Creator', 'Producer' и 'CreationDate'. Они могут быть удалены, установив им значение None.

addGouraudTriangles(self, points, colors) [source]

Добавление затенения треугольника Гуро

Параметры:	pointsnp.ndarray Вершины треугольника, форма (n, 3, 2), где n = количество треугольников, 3 = вершины, 2 = x, y. colorsnp.ndarray Цвета вершин, форма (n, 3, 1) или (n, 3, 4) как с точками, но последнее измерение — это либо (серый,) или (r, g, b, альфа).
Возвращает:	Имя, Ссылка

alphaState(self, alpha) [source]

Возвращает имя ExtGState, которое устанавливает альфа-значение.

beginStream(self, id, len, extra=None, png=None) [source]

close(self) [source]

Очистка всех буферов и освобождение всех ресурсов.

createType1Descriptor(self, t1font, fontfile) [source]

dviFontName(self, dvifont) [source]

Учитывая объект шрифта dvi, возвращает имя, подходящее для Op.selectfont. Это регистрирует информацию о шрифте в self.dviFontInfo, если она еще не зарегистрирована.

embedTTF(self, filename, characters) [source]

Встраивание шрифта TTF из указанного файла в документ.

endStream(self) [source]

finalize(self) [source]

Запись различных отложенных объектов и заключительной части PDF.

fontName(self, fontprop) [source]

Выбор шрифта на основе fontprop и возвращение имени, подходящего для Op.selectfont. Если fontprop — строка, она будет интерпретирована как имя файла шрифта.

hatchPattern(self, hatch_style) [source]

imageObject(self, image) [source]

Возвращает имя объекта изображения XObject, представляющего данное изображение.

markerObject(self, path, trans, fill, stroke, lw, joinstyle, capstyle) [source]

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

newPage(self, width, height) [source]

newTextnote(self, text, positionRect=[- 100, - 100, 0, 0]) [source]

output(self, *data) [source]

pathCollectionObject(self, gc, path, trans, padding, filled, stroked) [source]

static pathOperations(path, transform, clip=None, simplify=None, sketch=None) [source]

recordXref(self, id) [source]

reserveObject(self, name='') [source]

Зарезервировать ID для косвенного объекта. Имя используется для отладки, на случай, если мы забудем вывести объект с помощью writeObject.

write(self, data) [source]

writeExtGSTates(self) [source]

writeFonts(self) [source]

writeGouraudTriangles(self) [source]

writeHatches(self) [source]

writeImages(self) [source]

writeInfoDict(self) [source]

Запись словаря информации, проверка на корректность.

writeMarkers(self) [source]

writeObject(self, object, contents) [source]

writePath(self, path, transform, clip=False, sketch=None) [source]

writePathCollectionTemplates(self) [source]

writeTrailer(self) [source]

Запись трейлера PDF.

writeXref(self) [source]

Запись таблицы xref.

class matplotlib.backends.backend_pdf.PdfPages(filename, keep_empty=True, metadata=None) [source]

Базируется на object

Многостраничный файл PDF.

Примечания

На самом деле PdfPages является тонким оболочкой вокруг PdfFile, чтобы избежать путаницы при использовании savefig и забывании аргумента формата.

Примеры

>>> import matplotlib.pyplot as plt
>>> # Initialize:
>>> with PdfPages('foo.pdf') as pdf:
...     # As many times as you like, create a figure fig and save it:
...     fig = plt.figure()
...     pdf.savefig(fig)
...     # When no figure is specified the current figure is saved
...     pdf.savefig()

Создание нового объекта PdfPages.

Параметры:

filenamestr or path-like or file-like Диаграммы, использующие PdfPages.savefig, будут записаны в файл по этому адресу. Файл открывается сразу, и любые старые файлы с тем же именем будут перезаписаны. keep_emptybool, optional Если установлено в False, пустые файлы PDF будут автоматически удалены при закрытии. metadatadictionary, optional Объект словаря информации (см. раздел 10.2.1 PDF справки «Словарь информации документа»), например: {'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome fig'} Стандартные ключи — 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producer', 'CreationDate', 'ModDate', и 'Trapped'. Значения предопределены для 'Creator', 'Producer' и 'CreationDate'. Их можно удалить, установив значение None.

attach_note(self, text, positionRect=[- 100, - 100, 0, 0]) [source]

Добавить новую текстовую заметку на страницу, которая будет сохранена следующей. Необязательный параметр positionRect задает позицию новой заметки на странице. По умолчанию он находится вне страницы, чтобы убедиться, что он не отображается при печати.

close(self) [source]

Завершение работы объекта, делая файл базовым полным файлом PDF.

get_pagecount(self) [source]

Возвращает текущее количество страниц в многостраничном файле pdf.

infodict(self) [source]

Возвращает изменяемый объект словаря информации (см. раздел 10.2.1 PDF справки «Словарь информации документа»).

keep_empty

savefig(self, figure=None, **kwargs) [source]

Сохраняет Figure в этом файле как новую страницу.

Любые другие ключевые аргументы передаются методу savefig.

Параметры:	figureFigure or int, optional Указывает, какая фигура сохраняется в файл. Если не указано, сохраняется активная фигура. Если предоставлен экземпляр Figure, сохраняется эта фигура. Если указано целое число, ищется экземпляр фигуры по номеру.

class matplotlib.backends.backend_pdf.Reference(id) [source]

Базируется на object

Объект ссылки PDF. Используйте PdfFile.reserveObject() для создания ссылок.

pdfRepr(self) [source]

write(self, contents, file) [source]

class matplotlib.backends.backend_pdf.RendererPdf(file, image_dpi, height, width) [source]

Bases: matplotlib.backends._backend_pdf_ps.RendererPDFPSBase

property afm_font_cache

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

Примечания

Устарело начиная с версии 3.1:

check_gc(self, gc, fillcolor=None) [source]

draw_gouraud_triangle(self, gc, points, colors, trans) [source]

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

Параметры:	pointsarray-like, shape=(3, 2) Массив точек (x, y) для треугольника. colorsarray-like, shape=(3, 4) RGBA цвета для каждой точки треугольника. transformmatplotlib.transforms.Transform Аффинное преобразование, применяемое к точкам.

draw_gouraud_triangles(self, gc, points, colors, trans) [source]

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

Параметры:	pointsarray-like, shape=(N, 3, 2) Массив точек (x, y) для треугольников. colorsarray-like, shape=(N, 3, 4) Массив RGBA цветов для каждой точки треугольников. transformmatplotlib.transforms.Transform Аффинное преобразование, применяемое к точкам.

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

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

Параметры:

gcGraphicsContextBase Контекст графики с информацией о обрезке. xscalar Расстояние в физических единицах (точках или пикселях) от левой стороны холста. yscalar Расстояние в физических единицах (точках или пикселях) от нижней стороны холста. imarray-like, shape=(N, M, 4), dtype=np.uint8 Массив RGBA пикселей. transformmatplotlib.transforms.Affine2DBase Если и только если конкретный бэкэнд написан таким образом, что option_scale_image() возвращает True, аффинное преобразование может быть передано в draw_image(). Оно имеет вид экземпляра Affine2DBase. Вектор смещения преобразования задан в физических единицах (точках или пикселях). Обратите внимание, что преобразование не переопределяет x и y и должно быть применено до перевода результата на x и y (это можно сделать, добавив x и y к вектору смещения, определенному transform).

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

Отрисовка маркера в каждой вершине в пути.

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

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

Параметры:	gcGraphicsContextBase Контекст графики. marker_transmatplotlib.transforms.Transform Аффинное преобразование, применяемое к маркеру. transmatplotlib.transforms.Transform Аффинное преобразование, применяемое к пути.

draw_mathtext(self, gc, x, y, s, prop, angle) [source]

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

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

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

Отрисовка коллекции путей, выбирая свойства отрисовки из списков facecolors, edgecolors, linewidths, linestyles и antialiaseds. offsets — список смещений, которые следует применить к каждому пути. Смещения в offsets сначала преобразуются offsetTrans, прежде чем быть применёнными. offset_position может быть либо "screen", либо "data" в зависимости от пространства, в котором находятся смещения.

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

draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None) [source]

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

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

Параметры:	gcGraphicsContextBase Контекст графики. xfloat Координата x текста в координатах отображения. yfloat Координата y базы текста в координатах отображения. sstr Строка текста. propmatplotlib.font_manager.FontProperties Свойства шрифта. anglefloat Угол поворота в градусах против часовой стрелки. mtextmatplotlib.text.Text Исходный объект текста, подлежащий рендерингу.

Примечания

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

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

if 0: bbox_artist(self, renderer)

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

encode_string(self, s, fonttype) [source]

finalize(self) [source]

get_image_magnification(self) [source]

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

merge_used_characters(self, other) [source]

new_gc(self) [source]

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

track_characters(self, font, s) [source]

Отслеживает, какие символы необходимы из каждого шрифта.

class matplotlib.backends.backend_pdf.Stream(id, len, file, extra=None, png=None) [source]

Bases: object

Объект потока PDF.

У него нет метода pdfRepr. Вместо этого вызовите begin(), затем выведите содержимое потока, вызвав write(), и, наконец, вызовите end().

Параметры:

idint Идентификатор объекта потока. lenReference or None Неиспользуемый объект Reference для длины потока; None означает использование буфера памяти, поэтому длина может быть включена в строку. filePdfFile Базовый объект для записи потока. extradict from Name to anything, or None Дополнительные пары ключ-значение для включения в заголовок потока. pngdict or None Если данные уже закодированы в png, параметры декодирования.

compressobj

end(self) [source]

Завершить поток.

extra

file

id

len

pdfFile

pos

write(self, data) [source]

Записать данные в поток.

class matplotlib.backends.backend_pdf.Verbatim(x) [source]

Bases: object

Хранит текстовое содержимое PDF-команд для последующего включения в поток.

pdfRepr(self) [source]

matplotlib.backends.backend_pdf.fill(strings, linelen=75) [source]

Сформировать одну строку из последовательности строк, с пробелами между ними. Пробелы выбираются для формирования строк не более чем linelen символов, если это возможно.

matplotlib.backends.backend_pdf.pdfRepr(obj) [source]

Сопоставление Python-объектов с синтаксисом PDF.