matplotlib.backends.backend_pgf
¶matplotlib.backends.backend_pgf.
FigureCanvas
¶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
()¶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
()¶print_pdf
(fname_or_fh, *args, **kwargs)¶Use LaTeX to compile a Pgf generated figure to PDF.
print_pgf
(fname_or_fh, *args, **kwargs)¶Output pgf commands for drawing the figure so it can be included and rendered in latex documents.
print_png
(fname_or_fh, *args, **kwargs)¶Use LaTeX to compile a pgf figure to pdf and convert it to png.
matplotlib.backends.backend_pgf.
FigureManager
¶matplotlib.backends.backend_pgf.
FigureManagerPgf
(*args)¶matplotlib.backends.backend_pgf.
GraphicsContextPgf
¶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 custem preamble in the rc parameters.
get_width_height_descent
(text, prop)¶Get the width, total height and descent for a text typesetted by the current LaTeX environment.
matplotlib.backends.backend_pgf.
LatexManagerFactory
¶Bases: object
get_latex_manager
()¶previous_instance
= None¶matplotlib.backends.backend_pgf.
RendererPgf
(figure, fh, dummy=False)¶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)¶Draw an RGBA image.
Parameters: | gc :
x : scalar
y : scalar
im : array_like, shape=(N, M, 4), dtype=np.uint8
transform :
|
---|
draw_markers
(gc, marker_path, marker_trans, path, trans, rgbFace=None)¶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 :
marker_trans :
trans :
|
---|
draw_path
(gc, path, transform, rgbFace=None)¶Draws a Path
instance using the
given affine transform.
draw_tex
(gc, x, y, s, prop, angle, ismath='TeX!', mtext=None)¶draw_text
(gc, x, y, s, prop, angle, ismath=False, mtext=None)¶Draw the text instance
Parameters: | gc :
x : scalar
y : scalar
s : str
prop :
angle : scalar
mtext :
|
---|
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
()¶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
()¶return the canvas width and height in display coords
get_text_width_height_descent
(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
new_gc
()¶Return an instance of a GraphicsContextBase
option_image_nocomposite
()¶return whether to generate a composite image from multiple images on a set of axes
option_scale_image
()¶pgf backend supports affine transform of image.
points_to_pixels
(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.0 * dpi/72.0
Parameters: | points : scalar or array_like
|
---|---|
Returns: | Points converted to pixels |
matplotlib.backends.backend_pgf.
TmpDirCleaner
¶Bases: object
add
()¶cleanup_remaining_tmpdirs
()¶remaining_tmpdirs
= set()¶matplotlib.backends.backend_pgf.
common_texification
(text)¶Do some necessary and/or useful substitutions for texts to be included in LaTeX documents.
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.
get_texcommand
()¶Get chosen TeX system from rc.
matplotlib.backends.backend_pgf.
make_pdf_to_png_converter
()¶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)¶