matplotlib.backends.backend_pgf

matplotlib.backends.backend_pgf.FigureCanvas

别名 FigureCanvasPgf

类 matplotlib.backends.backend_pgf.FigureCanvasPgf(figure=None)

基类： FigureCanvasBase

draw()

渲染 Figure。

此方法必须遍历 Artist 树，即使没有产生输出，因为它会触发用户在将输出保存到磁盘之前可能希望访问的延迟工作。例如，计算限制、自动限制和刻度值。

filetypes = {'pdf': 'LaTeX 编译的 PGF 图片', 'pgf': 'LaTeX PGF 图片', 'png': '便携式网络图形'}

get_default_filetype()

返回由 rcParams["savefig.format"] 指定的默认保存图片文件格式（默认值：'png'）。

返回的字符串不包含句点。此方法在仅支持单一文件类型的后端中被覆盖。

get_renderer()

print_pdf(fname_or_fh, *, metadata=None, **kwargs)

使用 LaTeX 将 PGF 生成的图编译为 PDF。

print_pgf(fname_or_fh, **kwargs)

输出用于绘制图形的 PGF 宏，以便将其包含并在 LaTeX 文档中渲染。

print_png(fname_or_fh, **kwargs)

使用 LaTeX 将 PGF 图形编译为 PDF 并将其转换为 PNG。

异常 matplotlib.backends.backend_pgf.LatexError(message, latex_output='')

基类： Exception

类 matplotlib.backends.backend_pgf.LatexManager

基类: object

LatexManager 打开 LaTeX 应用程序实例，用于确定文本元素的度量。LaTeX 环境可以通过在 rcParams 中设置字体和/或自定义前导码来修改。

get_width_height_descent(text, prop)

获取当前 LaTeX 环境排版文本的宽度、总高度和下降量（以 TeX 点为单位）。

类 matplotlib.backends.backend_pgf.PdfPages(filename, *, metadata=None)

基类: object

使用 PGF 后端的多页 PDF 文件

示例

>>> 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 绘制的图将写入此位置的文件。任何同名旧文件都将被覆盖。

metadata字典，可选

信息字典对象（参见 PDF 参考手册第 10.2.1 节“文档信息字典”），例如：{'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome'}。

标准键包括 'Title'、'Author'、'Subject'、'Keywords'、'Creator'、'Producer'、'CreationDate'、'ModDate' 和 'Trapped'。“Creator”、“Producer”和“CreationDate”的值已预定义。可以通过将它们设置为 None 来移除它们。

请注意，某些版本的 LaTeX 引擎可能会忽略“Producer”键并将其设置为自身。

close()

完成此对象，在临时目录中运行 LaTeX 并将最终的 PDF 文件移动到 filename。

get_pagecount()

返回多页 PDF 文件中的当前页数。

savefig(figure=None, **kwargs)

将一个 Figure 保存到此文件作为新页面。

任何其他关键字参数都将传递给 savefig。

参数:

figureFigure 或整数，默认值：当前活动图形

要保存到文件的图形或图形索引。

类 matplotlib.backends.backend_pgf.RendererPgf(figure, fh)

基类： RendererBase

创建一个新的 PGF 渲染器，它将任何绘图指令转换为文本命令，以便在 LaTeX 的 pgfpicture 环境中解释。

属性：

figureFigure

用于初始化高度、宽度和 DPI 的 Matplotlib 图形。

fh类文件对象

绘图命令输出的文件句柄。

draw_image(gc, x, y, im, transform=None)

绘制 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)

在 path 的每个顶点（不包括控制点）绘制一个标记。

基本（回退）实现多次调用 draw_path。后端可能希望覆盖此方法，以便只绘制一次标记并多次重用它。

参数:

gcGraphicsContextBase

图形上下文。

marker_pathPath

标记的路径。

marker_transTransform

应用于标记的仿射变换。

pathPath

绘制标记的位置。

transTransform

应用于路径的仿射变换。

rgbFace颜色，可选

draw_path(gc, path, transform, rgbFace=None)

使用给定的仿射变换绘制 Path 实例。

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

绘制一个 TeX 实例。

参数:

gcGraphicsContextBase

图形上下文。

x浮点数

文本在显示坐标中的 x 位置。

y浮点数

文本基线在显示坐标中的 y 位置。

s字符串

TeX 文本字符串。

propFontProperties

字体属性。

angle浮点数

逆时针旋转角度（度）。

mtextText

要渲染的原始文本对象。

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

绘制文本实例。

参数:

gcGraphicsContextBase

图形上下文。

x浮点数

文本在显示坐标中的 x 位置。

y浮点数

文本基线在显示坐标中的 y 位置。

s字符串

文本字符串。

propFontProperties

字体属性。

angle浮点数

逆时针旋转角度（度）。

ismath布尔值 或 "TeX"

如果为 True，则使用 mathtext 解析器。

mtextText

要渲染的原始文本对象。

备注

后端实现者注意事项

RendererBase.draw_text 还支持将“TeX”传递给 ismath 参数以使用 TeX 渲染，但这对于实际的渲染后端来说不是必需的，实际上许多内置后端都不支持此功能。相反，TeX 渲染由 draw_tex 提供。

flipy()

返回 y 值是否从上到下递增。

请注意，这仅影响文本的绘制。

get_canvas_width_height()

返回画布在显示坐标中的宽度和高度。

get_text_width_height_descent(s, prop, ismath)

获取字符串 s 在显示坐标系中的宽度、高度和下降量（从底部到基线的偏移量），使用 FontProperties prop。

字符串 s 开头和结尾的空白字符包含在报告的宽度中。

option_image_nocomposite()

返回是否应跳过Matplotlib的图像合成。

光栅后端通常应返回 False（让 C 级光栅化器处理图像合成）；矢量后端通常应返回 not rcParams["image.composite_image"]。

option_scale_image()

返回 draw_image 中是否支持任意仿射变换（大多数矢量后端为 True）。

points_to_pixels(points)

将点转换为显示单位。

你需要重写此函数（除非你的后端没有DPI，例如postscript或svg）。一些成像系统假定每英寸像素的某个值

points to pixels = points * pixels_per_inch/72 * dpi/72

参数:

points浮点数或类数组

返回:

转换为像素的点

matplotlib.backends.backend_pgf.make_pdf_to_png_converter()

返回一个将 PDF 文件转换为 PNG 文件的函数。