matplotlib.backends.backend_pdf

PDF-приложение Matplotlib.

Автор: Jouni K Seppänen <jks@iki.fi> и другие.

matplotlib.backends.backend_pdf.FigureCanvas[source]

Псевдоним для FigureCanvasPdf

classmatplotlib.backends.backend_pdf.FigureCanvasPdf(figure=None)[source]

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

draw()[source]

Отобразить Figure.

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

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

fixed_dpi=72

get_default_filetype()[source]

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

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

print_pdf(filename, *, bbox_inches_restore=None, metadata=None)[source]

classmatplotlib.backends.backend_pdf.GraphicsContextPdf(file)[source]

Bases: GraphicsContextBase

alpha_cmd(alpha, forced, effective_alphas)[source]

capstyle_cmd(style)[source]

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

clip_cmd(cliprect, clippath)[source]

Устанавливает прямоугольник обрезки. Вызывает pop() и 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(other)[source]

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

dash_cmd(dashes)[source]

delta(other)[source]

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

fill(*args)[source]

Предикат: необходимо ли заполнять путь?

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

fillcolor_cmd(rgb)[source]

finalize()[source]

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

hatch_cmd(hatch, hatch_color)[source]

joinstyle_cmd(style)[source]

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

linewidth_cmd(width)[source]

paint()[source]

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

pop()[source]

push()[source]

rgb_cmd(rgb)[source]

stroke()[source]

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

классmatplotlib.backends.backend_pdf.Name(name)[source]

Основывается на object

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

name

pdfRepr()[source]

классmatplotlib.backends.backend_pdf.Op(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Основания: Enum

Операторы PDF (неполный список).

begin_text=b'BT'[source]

clip=b'W'[source]

close_fill_stroke=b'b'[source]

close_stroke=b's'[source]

closepath=b'h'[source]

concat_matrix=b'cm'[source]

curveto=b'c'[source]

end_text=b'ET'[source]

endpath=b'n'[source]

fill=b'f'[source]

fill_stroke=b'B'[source]

grestore=b'Q'[source]

gsave=b'q'[source]

lineto=b'l'[source]

moveto=b'm'[source]

classmethodpaint_path(fill, stroke)[source]

Возвращает оператор PDF для отрисовки траектории.

Параметры:

fillbool

Заливает траекторию цветом заливки.

strokebool

Отображает контур траектории цветом линии.

pdfRepr()[source]

rectangle=b're'[source]

selectfont=b'Tf'[source]

setcolor_nonstroke=b'scn'[source]

setcolor_stroke=b'SCN'[source]

setcolorspace_nonstroke=b'cs'[source]

setcolorspace_stroke=b'CS'[source]

setdash=b'd'[source]

setgray_nonstroke=b'g'[source]

setgray_stroke=b'G'[source]

setgstate=b'gs'[source]

setlinecap=b'J'[source]

setlinejoin=b'j'[source]

setlinewidth=b'w'[source]

setrgb_nonstroke=b'rg'[source]

setrgb_stroke=b'RG'[source]

заливка=b'sh'[source]

отобразить=b'Tj'[source]

отобразить кернинг=b'TJ'[source]

рисунок=b'S'[source]

текстовая матрица=b'Tm'[source]

позиция текста=b'Td'[source]

использовать xobject=b'Do'[source]

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

Bases: object

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

Параметры:

filenamestr или путь-подобный объект или файл-подобный объект

Целевой объект вывода; если строка, будет открыт файл для записи.

metadataсловарь из строк в строки и даты

Объект словаря информации (см. раздел справки по PDF 10.2.1 'Справочник по данным документа'), например: {'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome'}.

Стандартные ключи — 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producer', 'CreationDate', 'ModDate' и 'Trapped'. Значения для 'Creator', 'Producer' и 'CreationDate' были определены заранее. Их можно удалить, задав им значение None.

addGouraudTriangles(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(alpha)[source]

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

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

close()[source]

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

createType1Descriptor(t1font, fontfile)[source]

dviFontName(dvifont)[source]

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

embedTTF(filename, characters)[source]

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

endStream()[source]

finalize()[source]

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

fontName(fontprop)[source]

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

hatchPattern(hatch_style)[source]

imageObject(image)[source]

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

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

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

newPage(width, height)[source]

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

output(*data)[source]

outputStream(ref, data, *, extra=None)[source]

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

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

recordXref(id)[source]

reserveObject(name='')[source]

Зарезервировать идентификатор для косвенного объекта.

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

write(data)[source]

writeExtGSTates()[source]

writeFonts()[source]

writeGouraudTriangles()[source]

writeHatches()[source]

writeImages()[source]

writeInfoDict()[source]

Записать словарь info, проверив его правильность

writeMarkers()[source]

writeObject(object, contents)[source]

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

writePathCollectionTemplates()[source]

writeTrailer()[source]

Записать постскрипт PDF.

writeXref()[source]

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

classmatplotlib.backends.backend_pdf.PdfPages(filename, keep_empty=<object object>, metadata=None)[source]

Bases: 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.

Параметры:

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

Графики, использующие PdfPages.savefig, будут записаны в файл по этому пути. Файл открывается при первом сохранении изображения (любой более ранний файл с тем же именем будет перезаписан).

keep_emptyбулево, необязательно

Если установлено в False, пустые PDF-файлы будут автоматически удалены при закрытии.

metadataсловарь, необязательно

Объект словаря информации (см. раздел 10.2.1 'Document Information Dictionary' справочника PDF), например: {'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome'}.

Стандартные ключи — 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producer', 'CreationDate', 'ModDate' и 'Trapped'. Значения по умолчанию определены для 'Creator', 'Producer' и 'CreationDate'. Их можно удалить, установив их в None.

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

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

close()[source]

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

get_pagecount()[source]

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

infodict()[source]

Возвращает изменяемый объект словаря информации (см. раздел 10.2.1 'Document Information Dictionary' справочника PDF).

propertykeep_empty[source]

[Устарело]

Примечания

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

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

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

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

Параметры:

figureFigure или int, по умолчанию: активный рисунок

Рисунок или индекс рисунка, который сохраняется в файл.

classmatplotlib.backends.backend_pdf.Reference(id)[source]

Bases: object

Объект ссылки PDF.

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

pdfRepr()[source]

write(contents, file)[source]

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

Bases: RendererPDFPSBase

check_gc(gc, fillcolor=None)[source]

draw_gouraud_triangles(gc, points, colors, trans)[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) массив numpy.uint8

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

transformAffine2DBase

Если и только если конкретный бэкенд написан таким образом, что 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_pathPath

Путь для маркера.

marker_transTransform

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

pathPath

Позиции для отрисовки маркеров.

transTransform

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

rgbFaceцвет, необязательно

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

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 (списке матриц (3, 3)), а затем master_transform. Затем они сдвигаются на соответствующую запись в offsets, которая была предварительно преобразована с помощью offset_trans.

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

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

Базовая (по умолчанию) реализация выполняет несколько вызовов draw_path. Модули-бэкэнды могут переопределить этот метод, чтобы отрисовать каждый набор данных путей только один раз, а затем ссылаться на этот путь несколько раз с различными смещениями, цветами, стилями и т. д. Для помощи (и стандартизации) реализации в разных бэкэндах предоставляются генераторные методы _iter_collection_raw_paths и _iter_collection. Сильно рекомендуется использовать эти генераторы, чтобы изменения в поведении 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

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

encode_string(s, fonttype)[source]

finalize()[source]

get_image_magnification()[source]

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

new_gc()[source]

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

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

Bases: object

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

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

Параметры:

idint

Идентификатор объекта потока.

lenReference или None

Неиспользуемый объект Reference для длины потока; None означает использование буфера памяти, поэтому длина может быть встроена.

filePdfFile

Основной объект для записи потока.

extraСловарь из имени в любой тип данных или None

Дополнительные пары ключ-значение для включения в заголовок потока.

pngСловарь или None

Если данные уже закодированы в PNG, параметры декодирования.

compressobj

end()[source]

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

extra

file

id

len

pdfFile

pos

write(data)[source]

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

classmatplotlib.backends.backend_pdf.Verbatim(x)[source]

Bases: object

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

pdfRepr()[source]

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

Преобразование Python-объектов в синтаксис PDF.