matplotlib.backends.backend_pgf
#
- matplotlib.backends.backend_pgf.FigureCanvas[source]#
alias of
FigureCanvasPgf
- class matplotlib.backends.backend_pgf.FigureCanvasPgf(figure=None)[source]#
Bases:
FigureCanvasBase
- draw()[source]#
Render the
Figure
.This method must walk the artist tree, even if no output is produced, because it triggers deferred work that users may want to access before saving output to disk. For example computing limits, auto-limits, and tick values.
- filetypes = {'pdf': 'LaTeX compiled PGF picture', 'pgf': 'LaTeX PGF picture', 'png': 'Portable Network Graphics'}#
- get_default_filetype()[source]#
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.
- print_pdf(fname_or_fh, *, metadata=None, **kwargs)[source]#
Use LaTeX to compile a pgf generated figure to pdf.
- 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
rcParams
.
- class matplotlib.backends.backend_pgf.PdfPages(filename, *, keep_empty=<object object>, 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:
- 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
.Note that some versions of LaTeX engines may ignore the 'Producer' key and set it to themselves.
- class matplotlib.backends.backend_pgf.RendererPgf(figure, fh)[source]#
Bases:
RendererBase
Create a new PGF renderer that translates any drawing instruction into text commands to be interpreted in a latex pgfpicture environment.
- Attributes:
- figure
Figure
Matplotlib figure to initialize height, width and dpi from.
- fhfile-like
File handle for the output of the drawing commands.
- figure
- draw_image(gc, x, y, im, transform=None)[source]#
Draw an RGBA image.
- Parameters:
- gc
GraphicsContextBase
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.
- im(N, M, 4) array of
numpy.uint8
An array of RGBA pixels.
- transform
Affine2DBase
If and only if the concrete backend is written such that
option_scale_image
returnsTrue
, an affine transformation (i.e., anAffine2DBase
) may be passed todraw_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).
- gc
- draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]#
Draw a marker at each of path's vertices (excluding control points).
The base (fallback) implementation makes multiple calls to
draw_path
. 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_path
Path
The path for the marker.
- marker_trans
Transform
An affine transform applied to the marker.
- path
Path
The locations to draw the markers.
- trans
Transform
An affine transform applied to the path.
- rgbFacecolor, optional
- gc
- draw_path(gc, path, transform, rgbFace=None)[source]#
Draw a
Path
instance using the given affine transform.
- draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]#
Draw a TeX instance.
- Parameters:
- gc
GraphicsContextBase
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.
- prop
FontProperties
The font properties.
- anglefloat
The rotation angle in degrees anti-clockwise.
- mtext
Text
The original text object to be rendered.
- gc
- draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]#
Draw a text instance.
- Parameters:
- gc
GraphicsContextBase
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.
- prop
FontProperties
The font properties.
- anglefloat
The rotation angle in degrees anti-clockwise.
- ismathbool or "TeX"
If True, use mathtext parser. If "TeX", use tex for rendering.
- mtext
Text
The original text object to be rendered.
- gc
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.
- 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.Whitespace at the start and the end of s is included in the reported width.
- 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:
- pointsfloat or array-like
- Returns:
- Points converted to pixels