Version 3.0.2
matplotlib
Fork me on GitHub

matplotlib.backends.backend_pgf

matplotlib.backends.backend_pgf.FigureCanvas

alias of matplotlib.backends.backend_pgf.FigureCanvasPgf

class matplotlib.backends.backend_pgf.FigureCanvasPgf(figure)[source]

Bases: matplotlib.backend_bases.FigureCanvasBase

filetypes = {'pdf': 'LaTeX compiled PGF picture', 'pgf': 'LaTeX PGF picture', 'png': 'Portable Network Graphics'}
get_default_filetype()[source]

Get the default savefig file format as specified in rcParam savefig.format. Returned string excludes period. Overridden in backends that only support a single file type.

get_renderer()[source]
print_pdf(fname_or_fh, *args, **kwargs)[source]

Use LaTeX to compile a Pgf generated figure to PDF.

print_pgf(fname_or_fh, *args, **kwargs)[source]

Output pgf commands for drawing the figure so it can be included and rendered in latex documents.

print_png(fname_or_fh, *args, **kwargs)[source]

Use LaTeX to compile a pgf figure to pdf and convert it to png.

matplotlib.backends.backend_pgf.FigureManager

alias of matplotlib.backends.backend_pgf.FigureManagerPgf

class matplotlib.backends.backend_pgf.FigureManagerPgf(canvas, num)[source]

Bases: matplotlib.backend_bases.FigureManagerBase

class matplotlib.backends.backend_pgf.GraphicsContextPgf[source]

Bases: matplotlib.backend_bases.GraphicsContextBase

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

Bases: Exception

class matplotlib.backends.backend_pgf.LatexManager[source]

Bases: object

The LatexManager opens an instance of the LaTeX application for determining the metrics of text elements. The LaTeX environment can be modified by setting fonts and/or a custem preamble in the rc parameters.

get_width_height_descent(text, prop)[source]

Get the width, total height and descent for a text typesetted by the current LaTeX environment.

class matplotlib.backends.backend_pgf.LatexManagerFactory[source]

Bases: object

static get_latex_manager()[source]
previous_instance = None
class matplotlib.backends.backend_pgf.PdfPages(filename, *, keep_empty=True, metadata=None)[source]

Bases: object

A multi-page PDF file using the pgf backend

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. 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', 'Producer', 'Creator' and 'Trapped'. Values have been predefined for 'Creator' and 'Producer'. They can be removed by setting them to the empty string.

close()[source]

Finalize this object, running LaTeX in a temporary directory and moving the final pdf file to filename.

get_pagecount()[source]

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

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

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_pgf.RendererPgf(figure, fh, dummy=False)[source]

Bases: matplotlib.backend_bases.RendererBase

Creates a new PGF renderer that translates any drawing instruction into text commands to be interpreted in a latex pgfpicture environment.

Attributes:
figure : matplotlib.figure.Figure

Matplotlib figure to initialize height, width and dpi from.

fh : file-like

File handle for the output of the drawing commands.

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

Draw an RGBA image.

Parameters:
gc : GraphicsContextBase

a graphics context with clipping information.

x : scalar

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

y : scalar

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

im : array_like, shape=(N, M, 4), dtype=np.uint8

An array of RGBA pixels.

transform : matplotlib.transforms.Affine2DBase

If and only if the concrete backend is written such that option_scale_image() returns True, an affine transformation may be passed to draw_image(). It takes the form of a Affine2DBase instance. The translation vector of the transformation is given in physical units (i.e., dots or pixels). Note that the transformation does not override x and y, and has to be applied before translating the result by x and y (this can be accomplished by adding x and y to the translation vector defined by transform).

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

Draws a marker at each of the vertices in path. This includes all vertices, including control points on curves. To avoid that behavior, those vertices should be removed before calling this function.

This provides a fallback implementation of draw_markers that makes multiple calls to draw_path(). Some backends may want to override this method in order to draw the marker only once and reuse it multiple times.

Parameters:
gc : GraphicsContextBase

The graphics context

marker_trans : matplotlib.transforms.Transform

An affine transform applied to the marker.

trans : matplotlib.transforms.Transform

An affine transform applied to the path.

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

Draws a Path instance using the given affine transform.

draw_tex(gc, x, y, s, prop, angle, ismath='TeX!', mtext=None)[source]
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]

Draw the text instance

Parameters:
gc : GraphicsContextBase

the graphics context

x : scalar

the x location of the text in display coords

y : scalar

the y location of the text baseline in display coords

s : str

the text string

prop : matplotlib.font_manager.FontProperties

font properties

angle : scalar

the rotation angle in degrees

mtext : matplotlib.text.Text

the original text object to be rendered

Notes

backend implementers note

When you are trying to determine if you have gotten your bounding box right (which is what enables the text layout/alignment to work properly), it helps to change the line in text.py:

if 0: bbox_artist(self, renderer)

to if 1, and then the actual bounding box will be plotted along with your text.

flipy()[source]

Return true if y small numbers are top for renderer Is used for drawing text (matplotlib.text) and images (matplotlib.image) only

get_canvas_width_height()[source]

return the canvas width and height in display coords

get_text_width_height_descent(s, prop, ismath)[source]

Get the width, height, and descent (offset from the bottom to the baseline), in display coords, of the string s with FontProperties prop

new_gc()[source]

Return an instance of a GraphicsContextBase

option_image_nocomposite()[source]

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

option_scale_image()[source]

pgf backend supports affine transform of image.

points_to_pixels(points)[source]

Convert points to display units

You need to override this function (unless your backend doesn't have a dpi, e.g., postscript or svg). Some imaging systems assume some value for pixels per inch:

points to pixels = points * pixels_per_inch/72.0 * dpi/72.0
Parameters:
points : scalar or array_like

a float or a numpy array of float

Returns:
Points converted to pixels
class matplotlib.backends.backend_pgf.TmpDirCleaner[source]

Bases: object

static add(tmpdir)[source]
static cleanup_remaining_tmpdirs()[source]
remaining_tmpdirs = {}
matplotlib.backends.backend_pgf.common_texification(text)[source]

Do some necessary and/or useful substitutions for texts to be included in LaTeX documents.

matplotlib.backends.backend_pgf.get_fontspec()[source]

Build fontspec preamble from rc.

matplotlib.backends.backend_pgf.get_preamble()[source]

Get LaTeX preamble from rc.

matplotlib.backends.backend_pgf.get_texcommand()[source]

Deprecated since version 3.0: The get_texcommand function was deprecated in Matplotlib 3.0 and will be removed in 3.2.

Get chosen TeX system from rc.

matplotlib.backends.backend_pgf.make_pdf_to_png_converter()[source]

Returns a function that converts a pdf file to a png file.

matplotlib.backends.backend_pgf.repl_escapetext(m)
matplotlib.backends.backend_pgf.repl_mathdefault(m)
matplotlib.backends.backend_pgf.writeln(fh, line)[source]