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}
- 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]
-
Предикат: нужно ли штриховать путь (рисовать его контур)? Это проверяет различные условия, которые отключают штриховку пути, в этом случае он, вероятно, будет заполнен.
- classmatplotlib.backends.backend_pdf.Name(name)[source]
-
Bases:
objectОбъект имени PDF.
- statichexify(match)[source]
-
[Устарело]
Примечания
Устарело начиная с версии 3.6:
- name
- pdfRepr()[source]
- classmatplotlib.backends.backend_pdf.Op(value)[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]
- свойствоop[source]
- статический методpaint_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.Operator(op)[source]
-
Bases:
object[Устаревшее]
Примечания
Устарело начиная с версии 3.6:
- op
- pdfRepr()[source]
- classmatplotlib.backends.backend_pdf.PdfFile(filename, metadata=None)[source]
-
Bases:
objectОбъект файла PDF.
- Параметры:
-
- filenameстрока или путь или файл-подобный объект
-
Целевой объект вывода; если строка, будет открыт файл для записи.
- 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, альфа).
- Возвращает:
-
- Имя, ссылка
- 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]
- 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.
- classmatplotlib.backends.backend_pdf.PdfPages(filename, keep_empty=True, metadata=None)[source]
-
Bases:
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 или объект пути или файлоподобный объект
-
Диаграммы, использующие
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]
-
Добавить новую текстовую заметку на страницу, которая будет сохранена следующим.
- close()[source]
-
Завершить работу с этим объектом, превратив лежащий в основе файл в завершенный PDF-файл.
- get_pagecount()[source]
-
Возвращает текущее количество страниц в многостраничном PDF-файле.
- infodict()[source]
-
Возвращает изменяемый объект словаря информации (см. раздел 10.2.1 «Словарь информации документа» справочника PDF).
- keep_empty
- savefig(figure=None, **kwargs)[source]
-
Сохранить
Figureв этот файл как новую страницу.
- classmatplotlib.backends.backend_pdf.Reference(id)[source]
-
Bases:
objectОбъект ссылки PDF.
Используйте PdfFile.reserveObject(), чтобы создать ссылки.
- classmatplotlib.backends.backend_pdf.RendererPdf(file, image_dpi, height, width)[source]
-
Bases:
RendererPDFPSBase- check_gc(gc, fillcolor=None)[source]
- draw_gouraud_triangle(gc, points, colors, trans)[source]
-
Отрисовка треугольника с заливкой по методу Гоура.
- Параметры:
-
-
gc
GraphicsContextBase -
Контекст графики.
- points(3, 2) массив-подобный объект
-
Массив точек (x, y) для треугольника.
- colors(3, 4) массив-подобный объект
-
RGBA цвета для каждой точки треугольника.
-
transform
matplotlib.transforms.Transform -
Аффинное преобразование, применяемое к точкам.
-
gc
- draw_gouraud_triangles(gc, points, colors, trans)[source]
-
Отрисовка серии треугольников с заливкой по методу Гоура.
- Параметры:
-
- 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.
-
gc
- draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
-
Отрисовка маркера в каждой вершине path (исключая контрольные точки).
Основная (fallback) реализация выполняет несколько вызовов
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, offset_trans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[source]
-
Отрисовка набора путей.
Каждый путь сначала преобразуется соответствующей записью в all_transforms (список матриц (3, 3)), а затем — master_transform. Затем они переводятся соответствующей записью в offsets, которая предварительно преобразуется с помощью offset_trans.
facecolors, edgecolors, linewidths, linestyles и antialiased — списки, устанавливающие соответствующие свойства.
offset_position сейчас не используется, но аргумент сохраняется для обратной совместимости.
Базовая (fallback) реализация выполняет несколько вызовов
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
Примечания
Примечание для разработчиков модулей отображения:
При попытке определить, правильно ли вы получили прямоугольник (что позволяет правильно расположить/выровнять текст), полезно изменить строку в файле 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словарь из Имени в любое значение или 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]
-
[Устарело]
Примечания
Устарело начиная с версии 3.6: Используйте закупленную копию _fill.
- matplotlib.backends.backend_pdf.pdfRepr(obj)[source]
-
Преобразование объектов Python в синтаксис PDF.
© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.6.0/api/backend_pdf_api.html