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 в себя и возвращает 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.

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]

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.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, которое устанавливает alpha заданному значению.

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=<объект объект>, 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.

Параметры:

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

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

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

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

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.

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[source]

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

Примечания

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

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]

классmatplotlib.backends.backend_pdf.RendererPdf(file, image_dpi, height, width)[source]

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

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

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

Массив RGBA цветов для каждой вершины N треугольников.

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 (исключая контрольные точки).

Базовая (по умолчанию) реализация делает несколько вызовов 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]

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

Каждый путь сначала преобразуется с помощью соответствующей записи в all_transforms (списке матриц 3x3), а затем — с помощью 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

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

Примечания

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

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

if 0: bbox_artist(self, renderer)

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

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Словарь из Name в любой тип данных или 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.