matplotlib
Fork me on GitHub


Travis-CI:

This Page

matplotlib.backends.backend_pdf

A PDF matplotlib backend Author: Jouni K Seppänen <jks@iki.fi>

matplotlib.backends.backend_pdf.FigureCanvas

alias of FigureCanvasPdf

class matplotlib.backends.backend_pdf.FigureCanvasPdf(figure)

Bases: matplotlib.backend_bases.FigureCanvasBase

The canvas the figure renders into. Calls the draw and print fig methods, creates the renderers, etc…

Attributes

figure (matplotlib.figure.Figure) A high-level Figure instance
draw()
filetypes = {'pdf': 'Portable Document Format'}
fixed_dpi = 72
get_default_filetype()
print_pdf(filename, **kwargs)
matplotlib.backends.backend_pdf.FigureManager

alias of FigureManagerPdf

class matplotlib.backends.backend_pdf.FigureManagerPdf(canvas, num)

Bases: matplotlib.backend_bases.FigureManagerBase

class matplotlib.backends.backend_pdf.GraphicsContextPdf(file)

Bases: matplotlib.backend_bases.GraphicsContextBase

alpha_cmd(alpha, forced, effective_alphas)
capstyle_cmd(style)
capstyles = {'butt': 0, 'round': 1, 'projecting': 2}
clip_cmd(cliprect, clippath)

Set clip rectangle. Calls self.pop() and self.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)

Copy properties of other into self.

dash_cmd(dashes)
delta(other)

Copy properties of other into self and return PDF commands needed to transform self into other.

fill(*args)

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)
finalize()

Make sure every pushed graphics state is popped.

hatch_cmd(hatch, hatch_color)
joinstyle_cmd(style)
joinstyles = {'miter': 0, 'round': 1, 'bevel': 2}
linewidth_cmd(width)
paint()

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

pop()
push()
rgb_cmd(rgb)
stroke()

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

class matplotlib.backends.backend_pdf.Name(name)

Bases: object

PDF name object.

static hexify(match)
name
pdfRepr()
class matplotlib.backends.backend_pdf.Operator(op)

Bases: object

PDF operator object.

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

Bases: object

PDF file object.

addGouraudTriangles(points, colors)
alphaState(alpha)

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

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

Flush all buffers and free all resources.

createType1Descriptor(t1font, fontfile)
dviFontName(dvifont)

Given a dvi font object, return a name suitable for Op.selectfont. This registers the font information in self.dviFontInfo if not yet registered.

embedTTF(filename, characters)

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

endStream()
finalize()

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

fontName(fontprop)

Select a font based on fontprop and return a name suitable for Op.selectfont. If fontprop is a string, it will be interpreted as the filename of the font.

hatchPattern(hatch_style)
imageObject(image)

Return name of an image XObject representing the given image.

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

Return name of a marker XObject representing the given path.

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='')

Reserve an ID for an indirect object. The name is used for debugging in case we forget to print out the object with writeObject.

texFontMap
write(data)
writeFonts()
writeGouraudTriangles()
writeHatches()
writeImages()
writeInfoDict()

Write out the info dictionary, checking it for good form

writeMarkers()
writeObject(object, contents)
writePath(path, transform, clip=False, sketch=None)
writePathCollectionTemplates()
writeTrailer()

Write out the PDF trailer.

writeXref()

Write out the xref table.

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

Bases: object

A multi-page PDF file.

Notes

In reality PdfPages is a thin wrapper around PdfFile, in order to avoid confusion when using savefig() and forgetting the format argument.

Examples

>>> 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()

Create a new PdfPages object.

Parameters:

filename : str

Plots using PdfPages.savefig() will be written to a file at this location. The file is opened at once and any older file with the same name is overwritten.

keep_empty : bool, optional

If set to False, then empty pdf files will be deleted automatically when closed.

metadata : dictionary, optional

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

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 to None.

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

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

close()

Finalize this object, making the underlying file a complete PDF file.

get_pagecount()

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

infodict()

Return a modifiable information dictionary object (see PDF reference section 10.2.1 ‘Document Information Dictionary’).

keep_empty
savefig(figure=None, **kwargs)

Saves a Figure to this file as a new page.

Any other keyword arguments are passed to savefig().

Parameters:

figure : Figure or int, optional

Specifies what figure is saved to file. If not specified, the active figure is saved. If a Figure instance is provided, this figure is saved. If an int is specified, the figure instance to save is looked up by number.

class matplotlib.backends.backend_pdf.Reference(id)

Bases: object

PDF reference object. Use PdfFile.reserveObject() to create References.

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

Bases: matplotlib.backend_bases.RendererBase

afm_font_cache = {}
check_gc(gc, fillcolor=None)
draw_gouraud_triangle(gc, points, colors, trans)
draw_gouraud_triangles(gc, points, colors, trans)
draw_image(gc, x, y, im, transform=None)
draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)
draw_mathtext(gc, x, y, s, prop, angle)
draw_path(gc, path, transform, rgbFace=None)
draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)
draw_tex(gc, x, y, s, prop, angle, ismath='TeX!', mtext=None)
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)
encode_string(s, fonttype)
finalize()
flipy()
get_canvas_width_height()
get_image_magnification()
get_text_width_height_descent(s, prop, ismath)
merge_used_characters(other)
new_gc()
option_image_nocomposite()

return whether to generate a composite image from multiple images on a set of axes

option_scale_image()

pdf backend support arbitrary scaling of image.

track_characters(font, s)

Keeps track of which characters are required from each font.

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

Bases: object

PDF stream object.

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

id: object id of stream; len: an unused Reference object for the length of the stream, or None (to use a memory buffer); file: a PdfFile; extra: a dictionary of extra key-value pairs to include in the stream header; png: if the data is already png compressed, the decode parameters

compressobj
end()

Finalize stream.

extra
file
id
len
pdfFile
pos
write(data)

Write some data on the stream.

class matplotlib.backends.backend_pdf.Verbatim(x)

Bases: object

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

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

Make one string from sequence of strings, with whitespace in between. The whitespace is chosen to form lines of at most linelen characters, if possible.

matplotlib.backends.backend_pdf.pdfRepr(obj)

Map Python objects to PDF syntax.