matplotlib.backends.backend_pdf

A PDF matplotlib backend Автор: Jouni K Seppänen <jks@iki.fi>

matplotlib.backends.backend_pdf.FigureCanvas

alias of matplotlib.backends.backend_pdf.FigureCanvasPdf

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

Bases: matplotlib.backend_bases.FigureCanvasBase

draw()[source]

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

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

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

fixed_dpi = 72

get_default_filetype()[source]

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

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

print_pdf(filename, *, dpi=<deprecated parameter>, bbox_inches_restore=None, metadata=None)[source]

класс matplotlib.backends.backend_pdf.GraphicsContextPdf(file)[source]

Базы: matplotlib.backend_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]

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

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

Базы: object

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

статический hexify(match)[source]

name

pdfRepr()[source]

класс matplotlib.backends.backend_pdf.Op(value)[source]

Базы: matplotlib.backends.backend_pdf.Operator, enum.Enum

Перечисление.

begin_text = (b'BT',)

clip = b'W'

close_fill_stroke = b'b'

close_stroke = b's'

closepath = (b'h',)

concat_matrix = b'cm'

curveto = b'c'

end_text = b'ET'

endpath = b'n'

fill = b'f'

fill_stroke = b'B'

grestore = b'Q'

gsave = (b'q',)

lineto = b'l'

moveto = (b'm',)

op

статический метод paint_path(fill, stroke)[source]

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

Параметры:	fillbool Заполнить путь цветом заливки. strokebool Отобразить контур пути цветом линии.

rectangle = b're'

selectfont = b'Tf'

setcolor_nonstroke = b'scn'

setcolor_stroke = b'SCN'

setcolorspace_nonstroke = (b'cs',)

setcolorspace_stroke = b'CS'

setdash = (b'd',)

setgray_nonstroke = b'g'

setgray_stroke = (b'G',)

setgstate = b'gs'

setlinecap = b'J'

setlinejoin = b'j'

setlinewidth = b'w'

setrgb_nonstroke = (b'rg',)

setrgb_stroke = b'RG'

shading = b'sh'

show = b'Tj'

showkern = b'TJ'

stroke = b'S'

textmatrix = (b'Tm',)

textpos = b'Td'

use_xobject = b'Do'

класс matplotlib.backends.backend_pdf.Operator(op)[source]

Базы: object

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

op

pdfRepr()[source]

класс matplotlib.backends.backend_pdf.PdfFile(filename, metadata=None)[source]

Базы: 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, 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]

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

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

recordXref(id)[source]

reserveObject(name='')[source]

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

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

свойствоused_characters

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.

Параметры:

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

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

Сохранение Figure в этом файле в виде новой страницы.

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

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

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

Базы: object

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

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

pdfRepr()[source]

write(contents, file)[source]

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

Bases: matplotlib.backends._backend_pdf_ps.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 цвета для каждой точки треугольника. transformmatplotlib.transforms.Transform Аффинное преобразование, которое необходимо применить к точкам.

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

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

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

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(), может быть передан аффинное преобразование (т.е., Affine2DBase)возможно, для draw_image(). Вектор сдвига преобразования задается в физических единицах (т.е., точки или пиксели). Обратите внимание, что преобразование не переопределяет x и y и должно быть применено до перевода результата на x и y (это можно сделать, добавив x и y к вектору сдвига, определенному transform).

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

Отобразить маркер в каждой вершине path (исключая контрольные точки).

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

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

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, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[source]

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

offset_position может быть либо «screen», либо «data», в зависимости от пространства, в котором находятся смещения; «data» устарело.

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

draw_tex(gc, x, y, s, prop, angle, ismath=<deprecated parameter>, mtext=None)[source]

draw_text(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(s, fonttype)[source]

finalize()[source]

get_image_magnification()[source]

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

свойство mathtext_parser

merge_used_characters(*args, **kwargs)[source]

[Устарело]

Примечания

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

new_gc()[source]

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

track_characters(*args, **kwargs)[source]

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

Примечания

Устарело начиная с версии 3.3.

класс 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 в формате verbatim для последующего включения в поток.

pdfRepr()[source]

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

Создание одной строки из последовательности строк с пробелами между ними.

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

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

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