matplotlib.backends.backend_pdf
A PDF matplotlib backend Автор: Jouni K Seppänen <jks@iki.fi>
-
matplotlib.backends.backend_pdf.FigureCanvas
-
class matplotlib.backends.backend_pdf.FigureCanvasPdf(figure)[source] -
Bases:
matplotlib.backend_bases.FigureCanvasBaseПоверхность холста, на которую отрисовывается фигура. Вызывает методы draw и print fig, создаёт рендеры и т. д...
Атрибуты: -
figure : matplotlib.figure.Figure -
Экземпляр фигуры высокого уровня
-
draw()[source] -
Отображение
Figure.
-
filetypes = {'pdf': 'Portable Document Format'}
-
fixed_dpi = 72
-
get_default_filetype()[source] -
Получение формата файла сохранения по умолчанию, как указано в rcParam
savefig.format. Возвращаемая строка исключает точку. Переопределяется в бэкендах, которые поддерживают только один тип файла.
-
print_pdf(filename, *, dpi=72, bbox_inches_restore=None, metadata=None, **kwargs)[source]
-
-
class matplotlib.backends.backend_pdf.GraphicsContextPdf(file)[source] -
Bases:
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] -
Устанавливает прямоугольник обрезки. Вызывает self.pop() и self.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] -
Копирует свойства другого в себя.
-
dash_cmd(dashes)[source]
-
delta(other)[source] -
Копирует свойства другого в себя и возвращает PDF-команды, необходимые для преобразования self в другой.
-
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] -
Предикат: нужно ли обвести путь (нарисовать его контур)? Проверяются различные условия, которые отключают обводку пути, в этом случае, он, предположительно, будет заполнен.
-
-
class matplotlib.backends.backend_pdf.Name(name)[source] -
Bases:
objectОбъект имени PDF.
-
static hexify(match)[source]
-
name
-
pdfRepr()[source]
-
-
class matplotlib.backends.backend_pdf.Operator(op)[source] -
Bases:
objectОбъект оператора PDF.
-
op
-
pdfRepr()[source]
-
-
class matplotlib.backends.backend_pdf.PdfFile(filename, metadata=None)[source] -
Bases:
objectОбъект файла PDF.
-
addGouraudTriangles(points, colors)[source]
-
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]
-
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.
-
texFontMap -
Deprecated since version 3.0: Функция texFontMap была устаревшей в Matplotlib 3.0 и будет удалена в 3.2.
-
write(data)[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.
-
-
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.
Параметры: -
filename : str -
Графики, использующие
PdfPages.savefig(), будут записаны в файл по этому расположению. Файл открывается сразу, и любой более ранний файл с тем же именем перезаписывается. -
keep_empty : bool, optional -
Если установлено в значение False, то пустые файлы pdf будут автоматически удалены при закрытии.
-
metadata : dictionary, optional -
Объект словаря с информацией (см. раздел 10.2.1 PDF-справки «Словарь информации о документе»), например:
{'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome fig'}Стандартные ключи:
'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().Параметры: -
figure : Figure or int, optional -
Указывает, какая фигура сохраняется в файл. Если не указано, сохраняется активная фигура. Если предоставлен экземпляр
Figure, сохраняется эта фигура. Если указано целое число, экземпляр фигуры для сохранения ищется по номеру.
-
-
-
class 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]
-
Основы:
matplotlib.backend_bases.RendererBase-
afm_font_cache = {}
-
check_gc(gc, fillcolor=None)[source]
-
draw_gouraud_triangle(gc, points, colors, trans)[source] -
Отрисовка треугольника с интерполяцией цвета Гуро.
Параметры: -
points : array_like, shape=(3, 2) -
Массив точек (x, y) для треугольника.
-
colors : array_like, shape=(3, 4) -
RGBA цвета для каждой точки треугольника.
-
transform : matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к точкам.
-
-
draw_gouraud_triangles(gc, points, colors, trans)[source] -
Отрисовка серии треугольников с интерполяцией цвета Гуро.
Параметры: -
points : array_like, shape=(N, 3, 2) -
Массив из N точек (x, y) для треугольников.
-
colors : array_like, shape=(N, 3, 4) -
Массив из N значений RGBA цвета для каждой точки треугольников.
-
transform : matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к точкам.
-
-
draw_image(gc, x, y, im, transform=None)[source] -
Отрисовка RGBA изображения.
Параметры: -
gc : GraphicsContextBase -
объект контекста графики с информацией о обрезке.
-
x : scalar -
расстояние в физических единицах (например, точки или пиксели) от левой стороны холста.
-
y : scalar -
расстояние в физических единицах (например, точки или пиксели) от нижней стороны холста.
-
im : array_like, shape=(N, M, 4), dtype=np.uint8 -
Массив RGBA пикселей.
-
transform : matplotlib.transforms.Affine2DBase -
Если и только если конкретный бэкэнд написан таким образом, что
option_scale_image()возвращаетTrue, то аффинное преобразование может быть передано вdraw_image(). Оно имеет вид экземпляраAffine2DBase. Вектор сдвига преобразования задается в физических единицах (например, точки или пиксели). Обратите внимание, что преобразование не переопределяетxиy, и должно быть применено до преобразования результата с помощьюxиy(это можно сделать, добавивxиyк вектору сдвига, определенномуtransform).
-
-
draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source] -
Рисует маркер в каждой из вершин в пути. Это включает все вершины, включая контрольные точки на кривых. Чтобы избежать этого поведения, эти вершины должны быть удалены перед вызовом этой функции.
Это обеспечивает резервную реализацию draw_markers, которая выполняет несколько вызовов
draw_path(). Некоторые бэкэнды могут захотеть переопределить этот метод, чтобы нарисовать маркер только один раз и повторно использовать его несколько раз.Параметры: -
gc : GraphicsContextBase -
Контекст графики
-
marker_trans : matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к маркеру.
-
trans : matplotlib.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", в зависимости от пространства, в котором находятся сдвиги.
Это предоставляет резервную реализацию
draw_path_collection(), которая выполняет несколько вызововdraw_path(). Некоторые бэкэнды могут захотеть переопределить этот метод, чтобы отобразить каждый набор данных пути только один раз, а затем обратиться к этому пути несколько раз с различными смещениями, цветами, стилями и т. д. Методы генераторов_iter_collection_raw_paths()и_iter_collection()предназначены для помощи (и стандартизации) реализации по всем бэкендам. Настоятельно рекомендуется использовать эти генераторы, чтобы изменения в поведенииdraw_path_collection()можно было внести глобально.
-
draw_tex(gc, x, y, s, prop, angle, ismath='TeX!', mtext=None)[source]
-
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source] -
Отрисовка экземпляра текста.
Параметры: -
gc : GraphicsContextBase -
контекст графики
-
x : scalar -
координата x текста в координатах отображения
-
y : scalar -
координата y базовой линии текста в координатах отображения
-
s : str -
строка текста
-
prop : matplotlib.font_manager.FontProperties -
свойства шрифта
-
angle : scalar -
угол поворота в градусах
-
mtext : matplotlib.text.Text -
исходный объект текста для отрисовки
Примечания
примечание разработчикам бэкенда
При попытке определить, правильно ли вы получили прямоугольник обрезки (что необходимо для правильной работы выравнивания и расположения текста), полезно изменить строку в text.py:
if 0: bbox_artist(self, renderer)
на if 1, а затем прямоугольник обрезки будет нарисован вместе с текстом.
-
-
encode_string(s, fonttype)[source]
-
finalize()[source]
-
-
flipy()[source] -
Возвращает True, если для рендера y-маленькие числа находятся сверху. Используется только для отрисовки текста (
matplotlib.text) и изображений (matplotlib.image).
-
get_canvas_width_height()[source] -
Возвращает ширину и высоту холста в координатах отображения.
-
get_image_magnification()[source] -
Получить коэффициент увеличения изображений, передаваемых в
draw_image(). Позволяет бэкенду иметь изображения с разрешением, отличным от других элементов.
-
get_text_width_height_descent(s, prop, ismath)[source] -
Получить ширину, высоту и спуск (смещение от нижней границы до базовой линии) в координатах отображения строки s с
FontPropertiesprop.
-
merge_used_characters(other)[source]
-
new_gc()[source] -
Возвращает экземпляр
GraphicsContextBase.
-
option_image_nocomposite()[source] -
Возвращает, нужно ли генерировать составное изображение из нескольких изображений на наборе осей.
-
option_scale_image()[source] -
Бэкенд pdf поддерживает произвольное масштабирование изображений.
-
track_characters(font, s)[source] -
Отслеживает, какие символы требуются из каждого шрифта.
-
-
class matplotlib.backends.backend_pdf.Stream(id, len, file, extra=None, png=None)[source] -
Bases:
objectОбъект потока PDF.
У него нет метода pdfRepr. Вместо этого вызовите begin(), затем выведите содержимое потока, вызвав write(), и, наконец, вызовите end().
id: идентификатор объекта потока; len: неиспользуемый объект Reference для длины потока или None (для использования буфера памяти); file: файл PdfFile; extra: словарь дополнительных пар ключ-значение для включения в заголовок потока; png: если данные уже сжаты в PNG, параметры декодирования
-
compressobj
-
end()[source] -
Завершить поток.
-
extra
-
file
-
id
-
len
-
pdfFile
-
pos
-
write(data)[source] -
Записать данные в поток.
-
-
class matplotlib.backends.backend_pdf.Verbatim(x)[source] -
Bases:
objectХранит содержимое команд PDF в формате verbatim для последующего включения в поток.
-
pdfRepr()[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.0.0/api/backend_pdf_api.html