Spec-Zone.ru › Matplotlib 3.8

matplotlib.backends.backend_pgf

matplotlib.backends.backend_pgf.FigureCanvas[source]

псевдоним для FigureCanvasPgf

classmatplotlib.backends.backend_pgf.FigureCanvasPgf(figure=None)[source]

Базовые классы: FigureCanvasBase

draw()[source]

Отображение Figure.

Этот метод должен пройти по дереву элементов-артистов, даже если вывод не генерируется, так как это запускает отложенную работу, к которой пользователи могут получить доступ перед сохранением вывода на диск. Например, вычисление пределов, автоматические пределы и значения делений.

filetypes={'pdf': 'LaTeX скомпилированная картинка PGF', 'pgf': 'LaTeX картинка PGF', 'png': 'Графика Portable Network Graphics'}
get_default_filetype()[source]

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

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

get_renderer()[source]
print_pdf(fname_or_fh, *, metadata=None, **kwargs)[source]

Использует LaTeX для компиляции сгенерированной pgf картинки в pdf.

print_pgf(fname_or_fh, **kwargs)[source]

Выводит pgf макросы для отрисовки фигуры, чтобы её можно было включить и отобразить в документах latex.

print_png(fname_or_fh, **kwargs)[source]

Использует LaTeX для компиляции pgf фигуры в pdf и конвертирует её в png.

exceptionmatplotlib.backends.backend_pgf.LatexError(message, latex_output='')[source]

Базовые классы: Exception

classmatplotlib.backends.backend_pgf.LatexManager[source]

Базовые классы: object

LatexManager открывает экземпляр приложения LaTeX для определения метрик элементов текста. Окружение LaTeX можно изменить, установив шрифты и/или пользовательский преамбулу в rcParams.

get_width_height_descent(text, prop)[source]

Получение ширины, полной высоты и спуска (в TeX пунктах) для текста, набранного текущим окружением LaTeX.

END_OF_DOCUMENT_MARKER
classmatplotlib.backends.backend_pgf.PdfPages(filename, *, keep_empty=<object object>, metadata=None)[source]

Bases: object

Многостраничный PDF-файл, использующий backend pgf

Примеры

>>> 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, по умолчанию: True

Если установлено в 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.

Обратите внимание, что некоторые версии движков LaTeX могут игнорировать ключ 'Producer' и установить его себе.

close()[source]

Завершение работы с объектом, выполнение LaTeX в временной директории и перемещение итогового PDF-файла в filename.

get_pagecount()[source]

Возвращает текущее количество страниц в многостраничном PDF-файле.

propertykeep_empty[source]

[Устарело]

Примечания

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

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

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

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

Параметры:
figureFigure или int, по умолчанию: активный рисунок

Рисунки или индекс рисунка, который сохраняется в файл.

classmatplotlib.backends.backend_pgf.RendererPgf(figure, fh)[source]

Bases: RendererBase

Создайте новый рендерер PGF, который преобразует любые инструкции рисования в текстовые команды для интерпретации в среде latex pgfpicture.

Атрибуты:
figureFigure

Рисунок Matplotlib для инициализации высоты, ширины и dpi.

fhподобный файлу

Дескриптор файла для вывода команд рисования.

draw_image(gc, x, y, im, transform=None)[source]

Отобразить изображение в формате RGBA.

Параметры:
gcGraphicsContextBase

Контекст графики с информацией о обрезке.

xскаляр

Расстояние в физических единицах (точках или пикселях) от левой стороны холста.

yскаляр

Расстояние в физических единицах (точках или пикселях) от нижней стороны холста.

im(N, M, 4) массив numpy.uint8

Массив пикселей RGBA.

transformAffine2DBase

Если и только если конкретный бэкэнд написан таким образом, что option_scale_image возвращает True, может быть передано аффинное преобразование (т.е., Affine2DBase) может быть передано в draw_image. Вектор переноса преобразования задан в физических единицах (точках или пикселях). Обратите внимание, что преобразование не переопределяет x и y и должно быть применено до преобразования результата с помощью x и y (это можно сделать, добавив x и y к вектору переноса, определенному transform).

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

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

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

Параметры:
gcGraphicsContextBase

Контекст графики.

marker_pathPath

Путь для маркера.

marker_transTransform

Аффинное преобразование, применяемое к маркеру.

pathPath

Расположение для отображения маркеров.

transTransform

Аффинное преобразование, применяемое к пути.

rgbFaceцвет, необязательно
draw_path(gc, path, transform, rgbFace=None)[source]

Отобразить экземпляр Path с помощью заданного аффинного преобразования.

draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]

Отобразить экземпляр TeX.

Параметры:
gcGraphicsContextBase

Контекст графики.

xfloat

Положение x текста в координатах отображения.

yfloat

Положение y базовой линии текста в координатах отображения.

sstr

Строка текста TeX.

propFontProperties

Свойства шрифта.

anglefloat

Угол поворота в градусах против часовой стрелки.

mtextText

Оригинальный объект текста для рендеринга.

draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]

Отобразить текст.

Параметры:
gcGraphicsContextBase

Контекст графики.

xfloat

Координата x текста в координатах отображения.

yfloat

Координата y основания строки текста в координатах отображения.

sstr

Строка текста.

propFontProperties

Свойства шрифта.

anglefloat

Угол поворота в градусах против часовой стрелки.

ismathbool или "TeX"

Если True, используется математический парсер. Если "TeX", используется рендеринг TeX.

mtextText

Исходный объект текста для рендеринга.

Примечания

Примечание для разработчиков бэкендов:

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

if 0: bbox_artist(self, renderer)

на if 1, и тогда фактическая область обрезки будет отображаться вместе с текстом.

flipy()[source]

Возвращает, увеличиваются ли значения y сверху вниз.

Обратите внимание, что это влияет только на отображение текста.

get_canvas_width_height()[source]

Возвращает ширину и высоту холста в координатах отображения.

get_text_width_height_descent(s, prop, ismath)[source]

Возвращает ширину, высоту и спуск (смещение от нижней границы до основания строки) в координатах отображения строки s со свойством шрифта FontProperties prop.

Пробелы в начале и конце строки s учитываются при расчете ширины.

option_image_nocomposite()[source]

Возвращает, следует ли пропустить композицию изображений Matplotlib.

Векторные бэкенды обычно должны возвращать not rcParams["image.composite_image"]. Растровые бэкенды обычно должны возвращать False (позволяя C-уровневому растризатору позаботиться о композиции изображения).

option_scale_image()[source]

Возвращает, поддерживаются ли произвольные аффинные преобразования в draw_image (True для большинства векторных бэкендов).

points_to_pixels(points)[source]

Преобразует точки в единицы отображения.

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

points to pixels = points * pixels_per_inch/72 * dpi/72
Параметры:
pointsfloat или массив-подобный объект
Возвращает:
Точки, преобразованные в пиксели
matplotlib.backends.backend_pgf.make_pdf_to_png_converter()[source]

Возвращает функцию, преобразующую pdf-файл в png-файл.

© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.8.4/api/backend_pgf_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API