matplotlib.backends.backend_pdf#

A PDF Matplotlib backend.

Author: Jouni K Seppänen <jks@iki.fi> and others.

matplotlib.backends.backend_pdf.FigureCanvas[source]#

alias ofFigureCanvasPdf

classmatplotlib.backends.backend_pdf.FigureCanvasPdf(figure=None)[source]#

Bases:FigureCanvasBase

draw()[source]#

Render theFigure.

This method must walk the artist tree, even if no output is produced,because it triggers deferred work that users may want to accessbefore saving output to disk. For example computing limits,auto-limits, and tick values.

filetypes={'pdf':'PortableDocumentFormat'}#

fixed_dpi=72#

get_default_filetype()[source]#

Return the default savefig file format as specified inrcParams["savefig.format"] (default:'png').

The returned string does not include a period. This method isoverridden in backends that only support a single file type.

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}#

clip_cmd(cliprect,clippath)[source]#

Set clip rectangle. Callspop() andpush().

commands=((('_cliprect','_clippath'),<functionGraphicsContextPdf.clip_cmd>),(('_alpha','_forced_alpha','_effective_alphas'),<functionGraphicsContextPdf.alpha_cmd>),(('_capstyle',),<functionGraphicsContextPdf.capstyle_cmd>),(('_fillcolor',),<functionGraphicsContextPdf.fillcolor_cmd>),(('_joinstyle',),<functionGraphicsContextPdf.joinstyle_cmd>),(('_linewidth',),<functionGraphicsContextPdf.linewidth_cmd>),(('_dashes',),<functionGraphicsContextPdf.dash_cmd>),(('_rgb',),<functionGraphicsContextPdf.rgb_cmd>),(('_hatch','_hatch_color','_hatch_linewidth'),<functionGraphicsContextPdf.hatch_cmd>))#

copy_properties(other)[source]#

Copy properties of other into self.

dash_cmd(dashes)[source]#

delta(other)[source]#

Copy properties of other into self and return PDF commandsneeded to transformself intoother.

fill(*args)[source]#

Predicate: does the path need to be filled?

An optional argument can be used to specify an alternative_fillcolor, as needed by RendererPdf.draw_markers.

fillcolor_cmd(rgb)[source]#

finalize()[source]#

Make sure every pushed graphics state is popped.

hatch_cmd(hatch,hatch_color,hatch_linewidth)[source]#

joinstyle_cmd(style)[source]#

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

linewidth_cmd(width)[source]#

paint()[source]#

Return the appropriate pdf operator to cause the path to bestroked, filled, or both.

pop()[source]#

push()[source]#

rgb_cmd(rgb)[source]#

stroke()[source]#

Predicate: does the path need to be stroked (its outline drawn)?This tests for the various conditions that disable strokingthe path, in which case it would presumably be filled.

classmatplotlib.backends.backend_pdf.Name(name)[source]#

Bases:object

PDF name object.

name#

pdfRepr()[source]#

classmatplotlib.backends.backend_pdf.Op(*values)[source]#

Bases:Enum

PDF operators (not an exhaustive list).

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]#

classmethodpaint_path(fill,stroke)[source]#

Return the PDF operator to paint a path.

Parameters:

fillbool

Fill the path with the fill color.

strokebool

Stroke the outline of the path with the line color.

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.PdfFile(filename,metadata=None)[source]#

Bases:object

PDF file object.

Parameters:

filenamestr or path-like or file-like

Output target; if a string, a file will be opened for writing.

metadatadict from strings to strings and dates

Information dictionary object (see PDF reference section 10.2.1'Document Information Dictionary'), e.g.:{'Creator':'Mysoftware','Author':'Me','Title':'Awesome'}.

The standard keys are 'Title', 'Author', 'Subject', 'Keywords','Creator', 'Producer', 'CreationDate', 'ModDate', and'Trapped'. Values have been predefined for 'Creator', 'Producer'and 'CreationDate'. They can be removed by setting them toNone.

addGouraudTriangles(points,colors)[source]#

Add a Gouraud triangle shading.

Parameters:

pointsnp.ndarray

Triangle vertices, shape (n, 3, 2)where n = number of triangles, 3 = vertices, 2 = x, y.

colorsnp.ndarray

Vertex colors, shape (n, 3, 1) or (n, 3, 4)as with points, but last dimension is either (gray,)or (r, g, b, alpha).

Returns:

Name, Reference

alphaState(alpha)[source]#

Return name of an ExtGState that sets alpha to the given value.

beginStream(id,len,extra=None,png=None)[source]#

close()[source]#

Flush all buffers and free all resources.

createType1Descriptor(t1font,fontfile=<deprecatedparameter>)[source]#

propertydviFontInfo[source]#

[Deprecated]

Notes

Deprecated since version 3.11:

dviFontName(dvifont)[source]#

Given a dvi font object, return a name suitable for Op.selectfont.

Register the font internally (in_dviFontInfo) if not yet registered.

embedTTF(filename,characters)[source]#

Embed the TTF font from the named file into the document.

endStream()[source]#

finalize()[source]#

Write out the various deferred objects and the pdf end matter.

fontName(fontprop)[source]#

Select a font based on fontprop and return a name suitable forOp.selectfont. If fontprop is a string, it will be interpretedas the filename of the font.

propertyfontNames[source]#

[Deprecated]

Notes

Deprecated since version 3.11:

hatchPattern(hatch_style)[source]#

propertyhatchPatterns[source]#

[Deprecated]

Notes

Deprecated since version 3.10:

imageObject(image)[source]#

Return name of an image XObject representing the given image.

markerObject(path,trans,fill,stroke,lw,joinstyle,capstyle)[source]#

Return name of a marker XObject representing the given path.

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]#

Reserve an ID for an indirect object.

The name is used for debugging in case we forget to print outthe object with writeObject.

propertytype1Descriptors[source]#

[Deprecated]

Notes

Deprecated since version 3.11:

write(data)[source]#

writeExtGSTates()[source]#

writeFonts()[source]#

writeGouraudTriangles()[source]#

writeHatches()[source]#

writeImages()[source]#

writeInfoDict()[source]#

Write out the info dictionary, checking it for good form

writeMarkers()[source]#

writeObject(object,contents)[source]#

writePath(path,transform,clip=False,sketch=None)[source]#

writePathCollectionTemplates()[source]#

writeTrailer()[source]#

Write out the PDF trailer.

writeXref()[source]#

Write out the xref table.

classmatplotlib.backends.backend_pdf.PdfPages(filename,keep_empty=<deprecatedparameter>,metadata=None)[source]#

Bases:object

A multi-page PDF file.

Notes

In realityPdfPages is a thin wrapper aroundPdfFile, in order to avoidconfusion when usingsavefig and forgetting the format argument.

Examples

>>>importmatplotlib.pyplotasplt>>># Initialize:>>>withPdfPages('foo.pdf')aspdf:...# 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()

Create a new PdfPages object.

Parameters:

filenamestr or path-like or file-like

Plots usingPdfPages.savefig will be written to a file at this location.The file is opened when a figure is saved for the first time (overwritingany older file with the same name).

metadatadict, optional

Information dictionary object (see PDF reference section 10.2.1'Document Information Dictionary'), e.g.:{'Creator':'Mysoftware','Author':'Me','Title':'Awesome'}.

The standard keys are 'Title', 'Author', 'Subject', 'Keywords','Creator', 'Producer', 'CreationDate', 'ModDate', and'Trapped'. Values have been predefined for 'Creator', 'Producer'and 'CreationDate'. They can be removed by setting them toNone.

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

Add a new text note to the page to be saved next. The optionalpositionRect specifies the position of the new note on thepage. It is outside the page per default to make sure it isinvisible on printouts.

close()[source]#

Finalize this object, making the underlying file a completePDF file.

get_pagecount()[source]#

Return the current number of pages in the multipage pdf file.

infodict()[source]#

Return a modifiable information dictionary object(see PDF reference section 10.2.1 'Document InformationDictionary').

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

Save aFigure to this file as a new page.

Any other keyword arguments are passed tosavefig.

Parameters:

figureFigure or int, default: the active figure

The figure, or index of the figure, that is saved to the file.

classmatplotlib.backends.backend_pdf.Reference(id)[source]#

Bases:object

PDF reference object.

Use PdfFile.reserveObject() to create References.

pdfRepr()[source]#

write(contents,file)[source]#

classmatplotlib.backends.backend_pdf.RendererPdf(file,image_dpi,height,width)[source]#

Bases:RendererPDFPSBase

check_gc(gc,fillcolor=None)[source]#

draw_gouraud_triangles(gc,points,colors,trans)[source]#

Draw a series of Gouraud triangles.

Parameters:

gcGraphicsContextBase

The graphics context.

triangles_array(N, 3, 2) array-like

Array ofN (x, y) points for the triangles.

colors_array(N, 3, 4) array-like

Array ofN RGBA colors for each point of the triangles.

transformTransform

An affine transform to apply to the points.

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

Draw an RGBA image.

Parameters:

gcGraphicsContextBase

A graphics context with clipping information.

xfloat

The distance in physical units (i.e., dots or pixels) from the lefthand side of the canvas.

yfloat

The distance in physical units (i.e., dots or pixels) from thebottom side of the canvas.

im(N, M, 4) array ofnumpy.uint8

An array of RGBA pixels.

transformAffine2DBase

If and only if the concrete backend is written such thatoption_scale_image returnsTrue, an affinetransformation (i.e., anAffine2DBase)may be passed todraw_image. The translation vector of thetransformation is given in physical units (i.e., dots or pixels).Note that the transformation does not overridex andy,and has to be appliedbefore translatingthe result byx andy (this can be accomplished by addingxandy to the translation vector defined bytransform).

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

Draw a marker at each ofpath's vertices (excluding control points).

The base (fallback) implementation makes multiple calls todraw_path.Backends may want to override this method in order to draw the markeronly once and reuse it multiple times.

Parameters:

gcGraphicsContextBase

The graphics context.

marker_pathPath

The path for the marker.

marker_transTransform

An affine transform applied to the marker.

pathPath

The locations to draw the markers.

transTransform

An affine transform applied to the path.

rgbFacecolor, optional

draw_mathtext(gc,x,y,s,prop,angle)[source]#

draw_path(gc,path,transform,rgbFace=None)[source]#

Draw aPath instance using the given affine transform.

draw_path_collection(gc,master_transform,paths,all_transforms,offsets,offset_trans,facecolors,edgecolors,linewidths,linestyles,antialiaseds,urls,offset_position,*,hatchcolors=None)[source]#

Draw a collection ofpaths.

Each path is first transformed by the corresponding entryinall_transforms (a list of (3, 3) matrices) and then bymaster_transform. They are then translated by the correspondingentry inoffsets, which has been first transformed byoffset_trans.

facecolors,edgecolors,linewidths,linestyles,antialiasedandhatchcolors are lists that set the corresponding properties.

Added in version 3.11:Allowhatchcolors to be specified.

offset_position is unused now, but the argument is kept forbackwards compatibility.

The base (fallback) implementation makes multiple calls todraw_path.Backends may want to override this in order to render each set ofpath data only once, and then reference that path multiple times withthe different offsets, colors, styles etc. The generator methods_iter_collection_raw_paths and_iter_collection are provided tohelp with (and standardize) the implementation across backends. Itis highly recommended to use those generators, so that changes to thebehavior ofdraw_path_collection can be made globally.

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

Draw a TeX instance.

Parameters:

gcGraphicsContextBase

The graphics context.

xfloat

The x location of the text in display coords.

yfloat

The y location of the text baseline in display coords.

sstr

The TeX text string.

propFontProperties

The font properties.

anglefloat

The rotation angle in degrees anti-clockwise.

mtextText

The original text object to be rendered.

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

Draw a text instance.

Parameters:

gcGraphicsContextBase

The graphics context.

xfloat

The x location of the text in display coords.

yfloat

The y location of the text baseline in display coords.

sstr

The text string.

propFontProperties

The font properties.

anglefloat

The rotation angle in degrees anti-clockwise.

ismathbool or "TeX"

If True, use mathtext parser.

mtextText

The original text object to be rendered.

Notes

Notes for backend implementers:

RendererBase.draw_text also supports passing "TeX" to theismathparameter to use TeX rendering, but this is not required for actualrendering backends, and indeed many builtin backends do not supportthis. Rather, TeX rendering is provided bydraw_tex.

encode_string(s,fonttype)[source]#

finalize()[source]#

get_image_magnification()[source]#

Get the factor by which to magnify images passed todraw_image.Allows a backend to have images at a different resolution to otherartists.

new_gc()[source]#

Return an instance of aGraphicsContextBase.

classmatplotlib.backends.backend_pdf.Stream(id,len,file,extra=None,png=None)[source]#

Bases:object

PDF stream object.

This has no pdfRepr method. Instead, call begin(), then output thecontents of the stream by calling write(), and finally call end().

Parameters:

idint

Object id of the stream.

lenReference or None

An unused Reference object for the length of the stream;None means to use a memory buffer so the length can be inlined.

filePdfFile

The underlying object to write the stream to.

extradict from Name to anything, or None

Extra key-value pairs to include in the stream header.

pngdict or None

If the data is already png encoded, the decode parameters.

compressobj#

end()[source]#

Finalize stream.

extra#

file#

id#

len#

pdfFile#

pos#

write(data)[source]#

Write some data on the stream.

classmatplotlib.backends.backend_pdf.Verbatim(x)[source]#

Bases:object

Store verbatim PDF command content for later inclusion in the stream.

pdfRepr()[source]#

matplotlib.backends.backend_pdf.pdfRepr(obj)[source]#

Map Python objects to PDF syntax.