matplotlib.backends.backend_pgf
¶
-
matplotlib.backends.backend_pgf.
FigureCanvas
¶
-
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.
-
print_pdf
(fname_or_fh, *args, **kwargs)[source]¶ Use LaTeX to compile a Pgf generated figure to PDF.
-
-
matplotlib.backends.backend_pgf.
FigureManager
¶
-
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 custom preamble in the rc parameters.
-
class
matplotlib.backends.backend_pgf.
LatexManagerFactory
(**kwargs)[source]¶ Bases:
object
[Deprecated]
Notes
Deprecated since version 3.1:
-
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 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_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.
-
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, optionalSpecifies 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()
returnsTrue
, an affine transformation may be passed todraw_image()
. It takes the form of aAffine2DBase
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]¶ 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: 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]¶ Draw a
Path
instance using the given affine transform.
-
draw_text
(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]¶ Draw the text instance.
Parameters: gc :
GraphicsContextBase
The graphics context.
x : float
The x location of the text in display coords.
y : float
The y location of the text baseline in display coords.
s : str
The text string.
prop :
matplotlib.font_manager.FontProperties
The font properties.
angle : float
The rotation angle in degrees anti-clockwise.
mtext :
matplotlib.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
()[source]¶ Return whether y values increase from top to bottom.
Note that this only affects drawing of texts and images.
-
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
-
latexManager
¶
-
option_image_nocomposite
()[source]¶ 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
()[source]¶ Return whether arbitrary affine transformations in
draw_image()
are supported (True for most vector backends).
-
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 * dpi/72
Parameters: points : float or array-like
a float or a numpy array of float
Returns: Points converted to pixels
-
-
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.
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)[source]¶ [Deprecated]
Notes
Deprecated since version 3.2: