matplotlib.backends.backend_pdf
¶
A PDF matplotlib backend Author: Jouni K Seppänen <jks@iki.fi>
-
matplotlib.backends.backend_pdf.
FigureCanvas
¶
-
class
matplotlib.backends.backend_pdf.
FigureCanvasPdf
(figure)[source]¶ Bases:
matplotlib.backend_bases.FigureCanvasBase
The canvas the figure renders into. Calls the draw and print fig methods, creates the renderers, etc...
Attributes
figure ( matplotlib.figure.Figure
) A high-level Figure instance-
filetypes
= {'pdf': 'Portable Document Format'}¶
-
fixed_dpi
= 72¶
-
-
class
matplotlib.backends.backend_pdf.
GraphicsContextPdf
(file)[source]¶ Bases:
matplotlib.backend_bases.GraphicsContextBase
-
capstyles
= {'butt': 0, 'projecting': 2, 'round': 1}¶
-
commands
= ((('_cliprect', '_clippath'), <function GraphicsContextPdf.clip_cmd>), (('_alpha', '_forced_alpha', '_effective_alphas'), <function GraphicsContextPdf.alpha_cmd>), (('_capstyle',), <function GraphicsContextPdf.capstyle_cmd>), (('_fillcolor',), <function GraphicsContextPdf.fillcolor_cmd>), (('_joinstyle',), <function GraphicsContextPdf.joinstyle_cmd>), (('_linewidth',), <function GraphicsContextPdf.linewidth_cmd>), (('_dashes',), <function GraphicsContextPdf.dash_cmd>), (('_rgb',), <function GraphicsContextPdf.rgb_cmd>), (('_hatch', '_hatch_color'), <function GraphicsContextPdf.hatch_cmd>))¶
-
delta
(other)[source]¶ Copy properties of other into self and return PDF commands needed to transform self into other.
-
fill
(*args)[source]¶ Predicate: does the path need to be filled?
An optional argument can be used to specify an alternative _fillcolor, as needed by RendererPdf.draw_markers.
-
joinstyles
= {'bevel': 2, 'miter': 0, 'round': 1}¶
-
-
class
matplotlib.backends.backend_pdf.
PdfFile
(filename, metadata=None)[source]¶ Bases:
object
PDF file object.
Parameters: filename : str or path-like or file-like
Output target; if a string, a file will be opened for writing.
metadata : dict from strings to strings and dates
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'
,'Creator'
,'Producer'
,'CreationDate'
,'ModDate'
, and'Trapped'
. Values have been predefined for'Creator'
,'Producer'
and'CreationDate'
. They can be removed by setting them toNone
.-
addGouraudTriangles
(points, colors)[source]¶ Add a Gouraud triangle shading
Parameters: points : np.ndarray
Triangle vertices, shape (n, 3, 2) where n = number of triangles, 3 = vertices, 2 = x, y.
colors : np.ndarray
Vertex colors, shape (n, 3, 1) or (n, 3, 4) as with points, but last dimension is either (gray,) or (r, g, b, alpha).
Returns: Name, Reference
-
dviFontName
(dvifont)[source]¶ Given a dvi font object, return a name suitable for Op.selectfont. This registers the font information in self.dviFontInfo if not yet registered.
-
fontName
(fontprop)[source]¶ Select a font based on fontprop and return a name suitable for Op.selectfont. If fontprop is a string, it will be interpreted as the filename of the font.
-
markerObject
(path, trans, fill, stroke, lw, joinstyle, capstyle)[source]¶ Return name of a marker XObject representing the given path.
-
-
class
matplotlib.backends.backend_pdf.
PdfPages
(filename, keep_empty=True, metadata=None)[source]¶ Bases:
object
A multi-page PDF file.
Notes
In reality
PdfPages
is a thin wrapper aroundPdfFile
, in order to avoid confusion when usingsavefig
and forgetting the format argument.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 or file-like
Plots using
PdfPages.savefig
will be written to a file at this location. The file is opened at once and 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'
,'Creator'
,'Producer'
,'CreationDate'
,'ModDate'
, and'Trapped'
. Values have been predefined for'Creator'
,'Producer'
and'CreationDate'
. They can be removed by setting them toNone
.-
attach_note
(text, positionRect=[-100, -100, 0, 0])[source]¶ Add a new text note to the page to be saved next. The optional positionRect specifies the position of the new note on the page. It is outside the page per default to make sure it is invisible on printouts.
-
infodict
()[source]¶ Return a modifiable information dictionary object (see PDF reference section 10.2.1 'Document Information Dictionary').
-
keep_empty
¶
-
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_pdf.
Reference
(id)[source]¶ Bases:
object
PDF reference object. Use PdfFile.reserveObject() to create References.
-
class
matplotlib.backends.backend_pdf.
RendererPdf
(file, image_dpi, height, width)[source]¶ Bases:
matplotlib.backends._backend_pdf_ps.RendererPDFPSBase
-
afm_font_cache
¶ [Deprecated]
Notes
Deprecated since version 3.1:
-
draw_gouraud_triangle
(gc, points, colors, trans)[source]¶ Draw a Gouraud-shaded triangle.
Parameters: points : array-like, shape=(3, 2)
Array of (x, y) points for the triangle.
colors : array-like, shape=(3, 4)
RGBA colors for each point of the triangle.
transform :
matplotlib.transforms.Transform
An affine transform to apply to the points.
-
draw_gouraud_triangles
(gc, points, colors, trans)[source]¶ Draw a series of Gouraud triangles.
Parameters: points : array-like, shape=(N, 3, 2)
Array of N (x, y) points for the triangles.
colors : array-like, shape=(N, 3, 4)
Array of N RGBA colors for each point of the triangles.
transform :
matplotlib.transforms.Transform
An affine transform to apply to the points.
-
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_path_collection
(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[source]¶ Draw a collection of paths selecting drawing properties from the lists facecolors, edgecolors, linewidths, linestyles and antialiaseds. offsets is a list of offsets to apply to each of the paths. The offsets in offsets are first transformed by offsetTrans before being applied. offset_position may be either "screen" or "data" depending on the space that the offsets are in.
This provides a fallback implementation of
draw_path_collection()
that makes multiple calls todraw_path()
. Some backends may want to override this in order to render each set of path data only once, and then reference that path multiple times with the different offsets, colors, styles etc. The generator methods_iter_collection_raw_paths()
and_iter_collection()
are provided to help with (and standardize) the implementation across backends. It is highly recommended to use those generators, so that changes to the behavior ofdraw_path_collection()
can be made globally.
-
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.
-
get_image_magnification
()[source]¶ Get the factor by which to magnify images passed to
draw_image()
. Allows a backend to have images at a different resolution to other artists.
-
-
class
matplotlib.backends.backend_pdf.
Stream
(id, len, file, extra=None, png=None)[source]¶ Bases:
object
PDF stream object.
This has no pdfRepr method. Instead, call begin(), then output the contents of the stream by calling write(), and finally call end().
Parameters: id : int
Object id of the stream.
len : Reference or None
An unused Reference object for the length of the stream; None means to use a memory buffer so the length can be inlined.
file : PdfFile
The underlying object to write the stream to.
extra : dict from Name to anything, or None
Extra key-value pairs to include in the stream header.
png : dict or None
If the data is already png encoded, the decode parameters.
-
compressobj
¶
-
extra
¶
-
file
¶
-
id
¶
-
len
¶
-
pdfFile
¶
-
pos
¶
-
-
class
matplotlib.backends.backend_pdf.
Verbatim
(x)[source]¶ Bases:
object
Store verbatim PDF command content for later inclusion in the stream.