matplotlib.backends.backend_pdf

a pdf matplotlib后端作者：jouni k sepp_nen<jks@iki.fi>

matplotlib.backends.backend_pdf.FigureCanvas

alias of matplotlib.backends.backend_pdf.FigureCanvasPdf

class matplotlib.backends.backend_pdf.FigureCanvasPdf(figure)

基类：matplotlib.backend_bases.FigureCanvasBase

图形渲染到的画布。调用draw和print fig方法，创建渲染器等…

属性:

图形 ： matplotlib.figure.Figurematplotlib.figure.Figure

高级图形实例

filetypes = {'pdf': 'Portable Document Format'}

fixed_dpi = 72

get_default_filetype()

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

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

print_pdf(filename, *, dpi=72, bbox_inches_restore=None, metadata=None)

class matplotlib.backends.backend_pdf.GraphicsContextPdf(file)

基类：matplotlib.backend_bases.GraphicsContextBase

alpha_cmd(alpha, forced, effective_alphas)

capstyle_cmd(style)

capstyles = {'butt': 0, 'projecting': 2, 'round': 1}

clip_cmd(cliprect, clippath)

设置剪辑矩形。电话 pop() 和 push() .

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)

将其他属性复制到自身。

dash_cmd(dashes)

delta(other)

将其他属性复制到self中，并返回将self转换为其他属性所需的pdf命令。

fill(*args)

谓词：需要填充路径吗？

可选参数可用于根据renderPDF.draw标记的需要指定可选的fillColor。

fillcolor_cmd(rgb)

finalize()

确保弹出每个按下的图形状态。

hatch_cmd(hatch, hatch_color)

joinstyle_cmd(style)

joinstyles = {'bevel': 2, 'miter': 0, 'round': 1}

linewidth_cmd(width)

paint()

返回适当的PDF运算符以使路径被删除、填充或同时被删除。

pop()

push()

rgb_cmd(rgb)

stroke()

谓词：是否需要对路径进行笔画（绘制其轮廓）？这将测试禁用扫描路径的各种条件，在这种情况下，可能会填充路径。

class matplotlib.backends.backend_pdf.Name(name)

基类：object

PDF名称对象。

static hexify(match)

name

pdfRepr()

class matplotlib.backends.backend_pdf.Operator(op)

基类：object

PDF操作员对象。

op

pdfRepr()

class matplotlib.backends.backend_pdf.PdfFile(filename, metadata=None)

基类：object

PDF文件对象。

参数:

filenamestr或path like或file like

输出目标；如果是字符串，将打开一个文件进行写入。

metadata从字符串到字符串和日期的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 .

addGouraudTriangles(points, colors)

添加一个三角形。

参数:

pointsnp.ndarray

三角形顶点，形状（n，3，2），其中n=三角形数，3=顶点，2=x，y。

colorsnp.ndarray

顶点颜色，形状（n，3，1）或（n，3，4）和点一样，但最后一个维度是（灰色，）或（r，g，b，alpha）。

返回:

名称，参考号

alphaState(alpha)

返回将alpha设置为给定值的extgstate的名称。

beginStream(id, len, extra=None, png=None)

close()

刷新所有缓冲区并释放所有资源。

createType1Descriptor(t1font, fontfile)

dviFontName(dvifont)

给定一个dvi字体对象，返回一个适合操作选择字体. 这将在中注册字体信息 self.dviFontInfo 如果尚未注册。

embedTTF(filename, characters)

将命名文件中的ttf字体嵌入到文档中。

endStream()

finalize()

写出各种延迟对象和PDF的最终内容。

fontName(fontprop)

根据fontprop选择字体，并返回适合op.select font的名称。如果fontprop是字符串，它将被解释为字体的文件名。

hatchPattern(hatch_style)

imageObject(image)

返回表示给定图像的图像XObject的名称。

markerObject(path, trans, fill, stroke, lw, joinstyle, capstyle)

返回表示给定路径的标记XObject的名称。

newPage(width, height)

newTextnote(text, positionRect=[- 100, - 100, 0, 0])

output(*data)

pathCollectionObject(gc, path, trans, padding, filled, stroked)

static pathOperations(path, transform, clip=None, simplify=None, sketch=None)

recordXref(id)

reserveObject(name='')

为间接对象保留ID。

该名称用于调试，以防我们忘记打印带有writeObject的对象。

property used_characters

write(data)

writeExtGSTates()

writeFonts()

writeGouraudTriangles()

writeHatches()

writeImages()

writeInfoDict()

写出信息字典，检查它的格式是否正确。

writeMarkers()

writeObject(object, contents)

writePath(path, transform, clip=False, sketch=None)

writePathCollectionTemplates()

writeTrailer()

写出PDF预告片。

writeXref()

写出外部参照表。

class matplotlib.backends.backend_pdf.PdfPages(filename, keep_empty=True, metadata=None)

基类：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_empty可选的布尔

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

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 .

attach_note(text, positionRect=[- 100, - 100, 0, 0])

在下一页中添加新的文本注释以保存。可选的positionrect指定新注释在页面上的位置。默认情况下，它在页面之外，以确保它在打印输出中不可见。

close()

完成此对象，使基础文件成为完整的PDF文件。

get_pagecount()

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

infodict()

返回可修改的信息字典对象（参见PDF参考第10.2.1节“文档信息字典”）。

keep_empty

savefig(figure=None, **kwargs)

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

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

参数:

图形 ： Figure 或int，可选Figure或Int，可选

指定要保存到文件中的图形。如果未指定，则保存活动图形。如果A Figure 提供实例，保存此图。如果指定了int，将按数字查找要保存的图形实例。

class matplotlib.backends.backend_pdf.Reference(id)

基类：object

PDF引用对象。

使用PdfFile.reserveObject（）创建引用。

pdfRepr()

write(contents, file)

class matplotlib.backends.backend_pdf.RendererPdf(file, image_dpi, height, width)

基类：matplotlib.backends._backend_pdf_ps.RendererPDFPSBase

check_gc(gc, fillcolor=None)

draw_gouraud_triangle(gc, points, colors, trans)

画一个古鲁德阴影三角形。

参数:

gc ： GraphicsContextBaseGraphicsContextBase

图形上下文。

points类数组，形状=（3，2）

三角形的（x，y）点数组。

colors类数组，形状=（3，4）

三角形每个点的rgba颜色。

转型 ： matplotlib.transforms.Transformmatplotlib.transforms.Transform

应用于点的仿射变换。

draw_gouraud_triangles(gc, points, colors, trans)

画一系列的古劳德三角形。

参数:

points类数组，形状=（N，3，2）

数组 N （x，y）三角形的点。

colors类数组，形状=（N，3，4）

数组 N 每个三角形点的rgba颜色。

转型 ： matplotlib.transforms.Transformmatplotlib.transforms.Transform

应用于点的仿射变换。

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

绘制RGBA图像。

参数:

gc ： GraphicsContextBaseGraphicsContextBase

包含剪辑信息的图形上下文。

x标量

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

y标量

以物理单位（即点或像素）表示的与画布底部的距离。

im类数组，shape=（N，M，4），数据类型=np.uint8公司

一组rgba像素。

转型 ： matplotlib.transforms.Affine2DBasematplotlib.transforms.Affine2DBase

如果并且仅当具体的后端被写为 option_scale_image() 收益率 True ，仿射变换（即 Affine2DBase ） may 被传授给 draw_image() . 变换的平移向量以物理单位（即点或像素）给出。请注意，转换不会重写 x 和 y ，必须应用 之前 将结果转换为 x 和 y （这可以通过添加 x 和 y 到由定义的翻译矢量 转型 ）

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

在路径中的每个顶点绘制一个标记。

这包括所有顶点，包括曲线上的控制点。为了避免这种行为，应该在调用此函数之前删除这些顶点。

这提供了一个draw_标记的回退实现，该标记对 draw_path() . 有些后端可能希望重写此方法，以便只绘制一次标记并多次重复使用它。

参数:

gc ： GraphicsContextBaseGraphicsContextBase

图形上下文。

marker_trans ： matplotlib.transforms.Transformmatplotlib.transforms.Transform

应用于标记的仿射变换。

反式 ： matplotlib.transforms.Transformmatplotlib.transforms.Transform

应用于路径的仿射变换。

draw_mathtext(gc, x, y, s, prop, angle)

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

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

draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)

从列表中选择图形特性绘制路径集合 脸色 ， 绿色染料 ， 线宽度 ， 直线运动 和 抗混叠剂 . 偏移量 是要应用于每个路径的偏移列表。中的偏移量 偏移量 首先被 抵销交易 在应用之前。

offset_position 可以是“屏幕”或“数据”，具体取决于偏移所处的空间；“数据”已弃用。

这提供了 draw_path_collection() 打了多次电话给 draw_path() . 有些后端可能希望重写此项，以便只渲染一次每个路径数据集，然后使用不同的偏移量、颜色、样式等多次引用该路径。生成器方法 _iter_collection_raw_paths() 和 _iter_collection() 旨在帮助（和标准化）跨后端的实现。强烈建议使用这些生成器，以便更改 draw_path_collection() 可以在全球范围内生产。

draw_tex(gc, x, y, s, prop, angle, ismath=<deprecated parameter>, mtext=None)

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

绘制文本实例。

参数:

gc ： GraphicsContextBaseGraphicsContextBase

图形上下文。

x浮动

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

y浮动

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

sSTR

文本字符串。

prop ： matplotlib.font_manager.FontPropertiesmatplotlib.font_manager.FontProperties

字体属性。

angle浮动

以度为单位的逆时针旋转角度。

多行文本 ： matplotlib.text.Textmatplotlib.text.Text

要呈现的原始文本对象。

笔记

后端实现者注意：

当您试图确定边界框是否正确时（这是使文本布局/对齐方式正常工作的原因），它有助于更改文本中的线条。py:：

if 0: bbox_artist(self, renderer)

如果为1，则实际边界框将与文本一起打印。

encode_string(s, fonttype)

finalize()

get_image_magnification()

获取放大传递给的图像的因子 draw_image() . 允许后端对其他艺术家使用不同分辨率的图像。

merge_used_characters(*args, **kwargs)

[Deprecated]

笔记

3.3 版后已移除:

new_gc()

返回的实例 GraphicsContextBase .

track_characters(*args, **kwargs)

[Deprecated] 跟踪每个字体需要哪些字符。

笔记

3.3 版后已移除.

class matplotlib.backends.backend_pdf.Stream(id, len, file, extra=None, png=None)

基类：object

PDF流对象。

这没有pdfrepr方法。相反，调用begin（），然后通过调用write（）输出流的内容，最后调用end（）。

参数:

id利息

流的对象id。

len参考或无

流长度的未使用的引用对象；None表示使用内存缓冲区以便可以内联长度。

filePdfFile

要写入流的基础对象。

extra从名字到任何东西，或者没有

要包含在流标头中的额外键值对。

png不记名

如果数据已经被png编码，则解码参数。

compressobj

end()

完成流。

extra

file

id

len

pdfFile

pos

write(data)

在流上写一些数据。

class matplotlib.backends.backend_pdf.Verbatim(x)

基类：object

存储逐字PDF命令内容，以便稍后包含在流中。

pdfRepr()

matplotlib.backends.backend_pdf.fill(strings, linelen=75)

从字符串序列中生成一个字符串，中间有空格。

选择空格最多可以形成一行 莱恩 字符，如果可能的话。

matplotlib.backends.backend_pdf.pdfRepr(obj)

将python对象映射为pdf语法。