backend_pdf
PDF-приложение Matplotlib.
Автор: Жюни К. Сеппанен <jks@iki.fi> и другие.
- matplotlib.backends.backend_pdf.FigureCanvas[source]
- classmatplotlib.backends.backend_pdf.FigureCanvasPdf(figure=None)[source]
-
Базы:
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]
- classmatplotlib.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}
- 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',)[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]
- op
- classmethodpaint_path(fill, stroke)[source]
-
Возвращает оператор PDF для отрисовки пути.
- Параметры
-
- fillbool
-
Заполнить путь цветом заливки.
- strokebool
-
Отобразить контур пути цветом линии.
- 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Объект оператора PDF.
- op
- pdfRepr()[source]
- classmatplotlib.backends.backend_pdf.PdfFile(filename, metadata=None)[source]
-
Основания:
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]
- 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 или path-like или file-like
-
Графики, используемые с
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
- класс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]
-
Основы:
matplotlib.backends._backend_pdf_ps.RendererPDFPSBase- check_gc(gc, fillcolor=None)[source]
- draw_gouraud_triangle(gc, points, colors, trans)[source]
-
Отрисовка треугольника с плавной заливкой Gouraud.
- Параметры
-
-
gc
GraphicsContextBase -
Контекст графики.
- points(3, 2) массив-подобный
-
Массив точек (x, y) для треугольника.
- colors(3, 4) массив-подобный
-
RGBA цвета для каждой точки треугольника.
-
transform
matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к точкам.
-
gc
- draw_gouraud_triangles(gc, points, colors, trans)[source]
-
Отрисовка серии треугольников с плавной заливкой Gouraud.
- Параметры
-
- points(N, 3, 2) массив-подобный
-
Массив из N точек (x, y) для треугольников.
- colors(N, 3, 4) массив-подобный
-
Массив из N RGBA цветов для каждой точки треугольников.
-
transform
matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к точкам.
- draw_image(gc, x, y, im, transform=None)[source]
-
Отрисовка RGBA изображения.
- Параметры
-
-
gc
GraphicsContextBase -
Контекст графики с информацией о обрезке.
- xскаляр
-
Расстояние в физических единицах (т.е., точках или пикселях) от левой стороны холста.
- yскаляр
-
Расстояние в физических единицах (т.е., точках или пикселях) от нижней стороны холста.
- im(N, M, 4) массив-подобный типа np.uint8
-
Массив RGBA пикселей.
-
transform
matplotlib.transforms.Affine2DBase -
Если и только если конкретный бэкэнд написан таким образом, что
option_scale_image()возвращаетTrue, может быть передано аффинное преобразование (т.е.,Affine2DBase) кdraw_image(). Вектор сдвига преобразования задается в физических единицах (т.е., точках или пикселях). Обратите внимание, что преобразование не переопределяет x и y и должно применяться до перевода результата на x и y (это можно сделать, добавив x и y к вектору сдвига, определённому в transform).
-
gc
- draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
-
Отрисовка маркера в каждой из вершин path (исключая контрольные точки).
Это обеспечивает реализацию по умолчанию draw_markers, которая выполняет несколько вызовов
draw_path(). Некоторые бэкэнды могут захотеть переопределить этот метод, чтобы нарисовать маркер только один раз и повторно использовать его несколько раз.- Параметры
-
-
gc
GraphicsContextBase -
Контекст графики.
-
marker_trans
matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к маркерам.
-
trans
matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к пути.
-
gc
- 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 сейчас не используется, но аргумент сохраняется для обратной совместимости.
Это обеспечивает реализацию по умолчанию для
draw_path_collection(), которая делает несколько вызововdraw_path(). Некоторые бэкэнды могут захотеть переопределить это, чтобы отобразить каждый набор данных путей только один раз, а затем сослаться на этот путь несколько раз с различными смещениями, цветами, стилями и т. д. Генераторные методы_iter_collection_raw_paths()и_iter_collection()предназначены для помощи (и стандартизации) реализации в разных бэкэндах. Настоятельно рекомендуется использовать эти генераторы, чтобы изменения в поведенииdraw_path_collection()можно было внести глобально.
- draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]
- draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
-
Отобразить элемент текста.
- Параметры
-
-
gc
GraphicsContextBase -
Контекст графики.
- xfloat
-
Положение x текста в координатах отображения.
- yfloat
-
Положение y базовой линии текста в координатах отображения.
- sstr
-
Строка текста.
-
prop
matplotlib.font_manager.FontProperties -
Свойства шрифта.
- anglefloat
-
Угол поворота в градусах против часовой стрелки.
-
mtext
matplotlib.text.Text -
Исходный объект текста для отображения.
-
gc
Примечания
Примечание для разработчиков бэкэндов:
При попытке определить, правильно ли вы получили рамку (что позволяет правильно расположить и выровнять текст), полезно изменить строку в тексте.py:
if 0: bbox_artist(self, renderer)
на if 1, и тогда фактическая рамка будет отображена вместе с текстом.
- encode_string(s, fonttype)[source]
- finalize()[source]
- get_image_magnification()[source]
-
Получить коэффициент масштабирования изображений, переданных в
draw_image(). Позволяет бэкэнду иметь изображения с другим разрешением по сравнению с другими элементами.
- propertymathtext_parser[source]
- 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
-
Идентификатор объекта потока.
- lenСсылка или None
-
Неиспользуемый объект Ссылка для длины потока; None означает использование буфера памяти, поэтому длина может быть включена в строку.
- filePdfFile
-
Базовый объект для записи потока.
- extraСловарь из имени в любой тип данных или 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.fill(strings, linelen=75)[source]
-
Создаёт одну строку из последовательности строк с пробелами между ними.
Пробелы выбираются таким образом, чтобы строки имели не более linelen символов, если это возможно.
- matplotlib.backends.backend_pdf.pdfRepr(obj)[source]
-
Преобразует объекты Python в синтаксис PDF.
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/backend_pdf_api.html