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 в self.

dash_cmd(dashes)[source]

delta(other)[source]

Копирует свойства other в self и возвращает команды 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]

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

classmatplotlib.backends.backend_pdf.Name(name)[source]

Bases: object

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

statichexify(match)[source]

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

Примечания

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

name

pdfRepr()[source]

classmatplotlib.backends.backend_pdf.Op(value, names=None, *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]

propertyop[source]

[Устарело]

Примечания

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

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]

shading=b'sh'[source]

show=b'Tj'[source]

showkern=b'TJ'[source]

stroke=b'S'[source]

textmatrix=b'Tm'[source]

textpos=b'Td'[source]

use_xobject=b'Do'[source]

classmatplotlib.backends.backend_pdf.Operator(op)[source]

Bases: object

[Deprecated]

Примечания

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

op

pdfRepr()[source]

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

Bases: object

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

Параметры:

filenamestr или path-like или file-like

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

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

Объект словаря информации (см. раздел 10.2.1 «Словарь информации о документе» справочника PDF), например: {'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, alpha).

Возвращает:

Имя, ссылка

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.

класс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 или путь или файл-подобный объект

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

keep_emptybool, необязательно

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

metadatadict, необязательно

Объект словаря информации (см. раздел 10.2.1 «Словарь информации документа» в спецификации 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 «Словарь информации документа» в спецификации PDF).

keep_empty

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

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

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

Параметры:

figureFigure или int, по умолчанию: активная фигура

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

классmatplotlib.backends.backend_pdf.Reference(id)[source]

Базы: 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_triangle(gc, points, colors, trans)[source]

[Устарело] Рисование треугольника с интерполяцией цвета Горо.

Параметры:

gcGraphicsContextBase

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

points(3, 2) массив-подобный объект

Массив точек (x, y) для треугольника.

colors(3, 4) массив-подобный объект

Цвета RGBA для каждой точки треугольника.

transformTransform

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

Примечания

Устарело начиная с версии 3.7: Используйте draw_gouraud_triangles вместо него.

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) массив-подобный объект типа np.uint8

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

transformmatplotlib.transforms.Affine2DBase

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

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

transTransform

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

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]

Отрисовка набора путей.

Каждый путь сначала преобразуется соответствующей записью в all_transforms (список матриц (3, 3)), а затем — master_transform. Затем они переводятся с помощью соответствующей записи в offsets, которая предварительно преобразуется с помощью offset_trans.

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

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

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

Если True, используется математический парсер. Если "TeX", используется tex для отрисовки.

mtextText

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

Примечания

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

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

if 0: bbox_artist(self, renderer)

на if 1, и тогда вместе с текстом будет отображаться и сама область обрезки.

encode_string(s, fonttype)[source]

finalize()[source]

get_image_magnification()[source]

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

new_gc()[source]

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

классmatplotlib.backends.backend_pdf.Stream(id, len, file, extra=None, png=None)[source]

Базы: object

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

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

Параметры:

idint

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

lenСсылка или None

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

filePdfFile

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

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

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

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

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

compressobj

end()[source]

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

extra

file

id

len

pdfFile

pos

write(data)[source]

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

классmatplotlib.backends.backend_pdf.Verbatim(x)[source]

Базы: object

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

pdfRepr()[source]

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

[Устарело]

Замечания

Устарело начиная с версии 3.6: Используйте вложенную копию _fill.

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

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