matplotlib.backends.backend_pgf

matplotlib.backends.backend_pgf.FigureCanvas

alias of matplotlib.backends.backend_pgf.FigureCanvasPgf

class matplotlib.backends.backend_pgf.FigureCanvasPgf(figure)

Bases: matplotlib.backend_bases.FigureCanvasBase

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

get_default_filetype(self)

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

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

get_renderer(self)

print_pdf(self, fname_or_fh, *args, **kwargs)

Use LaTeX to compile a Pgf generated figure to PDF.

print_pgf(self, fname_or_fh, *args, **kwargs)

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

print_png(self, fname_or_fh, *args, **kwargs)

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

class matplotlib.backends.backend_pgf.GraphicsContextPgf(**kwargs)

Bases: matplotlib.backend_bases.GraphicsContextBase

[Deprecated]

Notes

Deprecated since version 3.3:

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

Bases: Exception

class matplotlib.backends.backend_pgf.LatexManager

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 custom preamble in rcParams.

get_width_height_descent(self, text, prop)

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

latex_stdin_utf8(self)

[Deprecated]

Notes

Deprecated since version 3.3:

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

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:

filenamestr or path-like

Plots using PdfPages.savefig will be written to a file at this location. Any older file with the same name is overwritten.

keep_emptybool, default: True

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

metadatadict, optional

Information dictionary object (see PDF reference section 10.2.1 'Document Information Dictionary'), e.g.: {'Creator': 'My software', '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 to None.

close(self)

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

get_pagecount(self)

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

keep_empty

property metadata

savefig(self, figure=None, **kwargs)

Save a Figure to this file as a new page.

Any other keyword arguments are passed to savefig.

Parameters:

figureFigure 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=<deprecated parameter>)

Bases: matplotlib.backend_bases.RendererBase

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

Attributes:

figurematplotlib.figure.Figure

Matplotlib figure to initialize height, width and dpi from.

fhfile-like

File handle for the output of the drawing commands.

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

Draw an RGBA image.

Parameters:

gcGraphicsContextBase

A graphics context with clipping information.

xscalar

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

yscalar

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

imarray-like, shape=(N, M, 4), dtype=np.uint8

An array of RGBA pixels.

transformmatplotlib.transforms.Affine2DBase

If and only if the concrete backend is written such that option_scale_image() returns True, an affine transformation (i.e., an Affine2DBase) may be passed to draw_image(). 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(self, gc, marker_path, marker_trans, path, trans, rgbFace=None)

Draw 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:

gcGraphicsContextBase

The graphics context.

marker_transmatplotlib.transforms.Transform

An affine transform applied to the marker.

transmatplotlib.transforms.Transform

An affine transform applied to the path.

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

Draw a Path instance using the given affine transform.

draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None)

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

Draw the 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.

propmatplotlib.font_manager.FontProperties

The font properties.

anglefloat

The rotation angle in degrees anti-clockwise.

mtextmatplotlib.text.Text

The original text object to be rendered.

Notes

Note for backend implementers:

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

Return whether y values increase from top to bottom.

Note that this only affects drawing of texts and images.

get_canvas_width_height(self)

Return the canvas width and height in display coords.

get_text_width_height_descent(self, s, prop, ismath)

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

property latexManager

option_image_nocomposite(self)

Return whether image composition by Matplotlib should be skipped.

Raster backends should usually return False (letting the C-level rasterizer take care of image composition); vector backends should usually return not rcParams["image.composite_image"].

option_scale_image(self)

Return whether arbitrary affine transformations in draw_image() are supported (True for most vector backends).

points_to_pixels(self, points)

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 * dpi/72

Parameters:

pointsfloat or array-like

a float or a numpy array of float

Returns:

Points converted to pixels

class matplotlib.backends.backend_pgf.TmpDirCleaner

Bases: object

static add(tmpdir)

static cleanup_remaining_tmpdirs()

remaining_tmpdirs = {}

matplotlib.backends.backend_pgf.common_texification(text)

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

This distinguishes text-mode and math-mode by replacing the math separator $ with \(\displaystyle %s\). Escaped math separators (\$) are ignored.

The following characters are escaped in text segments: _^$%

matplotlib.backends.backend_pgf.get_fontspec()

Build fontspec preamble from rc.

matplotlib.backends.backend_pgf.get_preamble()

Get LaTeX preamble from rc.

matplotlib.backends.backend_pgf.make_pdf_to_png_converter()

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

matplotlib.backends.backend_pgf.repl_escapetext(m)

[Deprecated]

Notes

Deprecated since version 3.2:

matplotlib.backends.backend_pgf.repl_mathdefault(m)

[Deprecated]

Notes

Deprecated since version 3.2:

matplotlib.backends.backend_pgf.writeln(fh, line)