matplotlib.backends.backend_pdf
PDF-поддержка matplotlib Автор: 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 высокого уровня
-
filetypes = {'pdf': 'Portable Document Format'}
-
fixed_dpi = 72
-
get_default_filetype(self)[source] -
Возвращает формат файла сохранения по умолчанию, указанный в
rcParams["savefig.format"](по умолчанию:'png').Возвращаемая строка не включает точку. Этот метод переопределён в тех бэкендах, которые поддерживают только один тип файла.
-
print_pdf(self, filename, *, dpi=72, bbox_inches_restore=None, metadata=None)[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)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(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'}.Стандартные ключи: «Название», «Автор», «Тема», «Ключевые слова», «Создатель», «Производитель», «Дата создания», «Дата изменения» и «Заблокировано». Значения для «Создатель», «Производитель» и «Дата создания» были предопределены. Их можно удалить, установив значение
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] -
Зарезервировать идентификатор для косвенного объекта.
Имя используется для отладки, на случай, если мы забудем вывести объект с помощью writeObject.
-
property used_characters
-
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 будут автоматически удалены при закрытии.
-
metadatadict, optional -
Объект словаря информации (см. раздел 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(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-
check_gc(self, gc, fillcolor=None)[source]
-
draw_gouraud_triangle(self, gc, points, colors, trans)[source] -
Нарисовать треугольник с интерполяцией цвета Гуро.
Параметры: -
gcGraphicsContextBase -
Контекст графики.
-
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) -
Массив N (x, y) точек для треугольников.
-
colorsarray-like, shape=(N, 3, 4) -
Массив N 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, может быть передано аффинное преобразование (т.е.Affine2DBase) может быть переданоdraw_image(). Вектор смещения преобразования задаётся в физических единицах (точках или пикселях). Обратите внимание, что преобразование не переопределяет 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", в зависимости от пространства, в котором находятся смещения; "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=<deprecated parameter>, 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, *args, **kwargs)[source] -
[Устаревшее]
Примечания
Устарело начиная с версии 3.3:
-
new_gc(self)[source] -
Возвращает экземпляр
GraphicsContextBase.
-
track_characters(self, *args, **kwargs)[source] -
[Устаревшее] Отслеживает, какие символы требуются от каждого шрифта.
Примечания
Устарело начиная с версии 3.3.
-
-
class matplotlib.backends.backend_pdf.Stream(id, len, file, extra=None, png=None)[source] -
Базы:
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] -
Базы:
objectХранение содержимого команд PDF в виде verbatim для последующего включения в поток.
-
pdfRepr(self)[source]
-
-
matplotlib.backends.backend_pdf.fill(strings, linelen=75)[source] -
Создание одной строки из последовательности строк с пробелами между ними.
Пробелы выбираются так, чтобы сформировать строки не более чем из linelen символов, если это возможно.
-
matplotlib.backends.backend_pdf.pdfRepr(obj)[source] -
Сопоставление объектов Python с синтаксисом PDF.
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/backend_pdf_api.html