matplotlib.backends.backend_pgf

matplotlib.backends.backend_pgf.FigureCanvas

FigureCanvasPgf 的别名

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

基类：FigureCanvasBase

draw()

渲染 Figure。

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

filetypes = {'pdf': 'LaTeX compiled PGF picture', 'pgf': 'LaTeX PGF picture', 'png': 'Portable Network Graphics'}

get_default_filetype()

返回在 rcParams["savefig.format"] (default: 'png') 中指定的默认 savefig 文件格式。

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

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。

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

基类：Exception

class matplotlib.backends.backend_pgf.LatexManager

基类：object

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

get_width_height_descent(text, prop)

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

class matplotlib.backends.backend_pgf.PdfPages(filename, *, keep_empty=<object object>, 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 对象。

参数:

文件名str 或 path-like

使用 PdfPages.savefig 绘制的图将写入此位置的文件中。任何同名旧文件将被覆盖。

keep_emptybool, 默认值: True

如果设置为 False，则在关闭时会自动删除空的 PDF 文件。

元数据dict, 可选

信息字典对象（参见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文件中的当前页数。

property keep_empty

!! 由 numpydoc 处理 !!

savefig(figure=None, **kwargs)

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

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

参数:

figure : Figure 或 int, 默认: 当前活动图形图或整数，默认值：当前活动图

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

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

基类：RendererBase

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

属性:

figure图

Matplotlib 图形以初始化高度、宽度和 dpi。

fh类文件

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

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

绘制一个RGBA图像。

参数:

gcGraphicsContextBase

带有裁剪信息的图形上下文。

x标量

画布左侧的物理单位（即点或像素）距离。

y标量

画布底部边缘的物理单位（即点或像素）距离。

im : (N, M, 4) 的 numpy.uint8 数组(N, M, 4) 数组

一个包含RGBA像素的数组。

变换 : Affine2DBaseAffine2DBase

当且仅当具体的后端被编写为 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_path路径

标记的路径。

marker_trans变换

应用于标记的仿射变换。

路径 : Path路径

绘制标记的位置。

trans变换

应用于路径的仿射变换。

rgbFace : color, 可选颜色，可选

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

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

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

绘制一个 TeX 实例。

参数:

gcGraphicsContextBase

图形上下文。

xfloat

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

yfloat

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

sstr

TeX 文本字符串。

propFontProperties

字体属性。

角度float

逆时针方向的旋转角度（以度为单位）。

mtext文本

要渲染的原始文本对象。

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

绘制一个文本实例。

参数:

gcGraphicsContextBase

图形上下文。

xfloat

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

yfloat

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

sstr

文本字符串。

propFontProperties

字体属性。

角度float

逆时针方向的旋转角度（以度为单位）。

ismath布尔值或“TeX”

如果为真，使用 mathtext 解析器。

mtext文本

要渲染的原始文本对象。

注释

后端实现者须知：

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

参数:

点浮点数或类似数组

返回:

点转换为像素

matplotlib.backends.backend_pgf.make_pdf_to_png_converter()

返回一个将pdf文件转换为png文件的函数。