doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
extra | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Stream.extra |
file | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Stream.file |
id | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Stream.id |
len | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Stream.len |
pdfFile | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Stream.pdfFile |
pos | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Stream.pos |
write(data)[source]
Write some data on the stream. | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Stream.write |
classmatplotlib.backends.backend_pdf.Verbatim(x)[source]
Bases: object Store verbatim PDF command content for later inclusion in the stream. pdfRepr()[source] | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Verbatim |
pdfRepr()[source] | matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Verbatim.pdfRepr |
matplotlib.backends.backend_pgf.common_texification(text)[source]
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.backend_pgf_api#matplotlib.backends.backend_pgf.common_texification |
matplotlib.backends.backend_pgf.FigureCanvas[source]
alias of matplotlib.backends.backend_pgf.FigureCanvasPgf | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvas |
classmatplotlib.backends.backend_pgf.FigureCanvasPgf(figure=None)[source]
Bases: matplotlib.backend_bases.FigureCanvasBase draw()[source]
Render the Figure. It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk.
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.
get_renderer()[source]
print_pdf(fname_or_fh, *, metadata=None, **kwargs)[source]
Use LaTeX to compile a pgf generated figure to pdf.
print_pgf(fname_or_fh, **kwargs)[source]
Output pgf macros for drawing the figure so it can be included and rendered in latex documents.
print_png(fname_or_fh, **kwargs)[source]
Use LaTeX to compile a pgf figure to pdf and convert it to png. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf |
draw()[source]
Render the Figure. It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf.draw |
filetypes={'pdf': 'LaTeX compiled PGF picture', 'pgf': 'LaTeX PGF picture', 'png': 'Portable Network Graphics'} | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf.filetypes |
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. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf.get_default_filetype |
get_renderer()[source] | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf.get_renderer |
print_pdf(fname_or_fh, *, metadata=None, **kwargs)[source]
Use LaTeX to compile a pgf generated figure to pdf. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf.print_pdf |
print_pgf(fname_or_fh, **kwargs)[source]
Output pgf macros for drawing the figure so it can be included and rendered in latex documents. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf.print_pgf |
print_png(fname_or_fh, **kwargs)[source]
Use LaTeX to compile a pgf figure to pdf and convert it to png. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.FigureCanvasPgf.print_png |
matplotlib.backends.backend_pgf.get_fontspec()[source]
Build fontspec preamble from rc. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.get_fontspec |
matplotlib.backends.backend_pgf.get_preamble()[source]
Get LaTeX preamble from rc. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.get_preamble |
exceptionmatplotlib.backends.backend_pgf.LatexError(message, latex_output='')[source]
Bases: Exception | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.LatexError |
classmatplotlib.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. get_width_height_descent(text, prop)[source]
Get the width, total height, and descent (in TeX points) for a text typeset by the current LaTeX environment.
propertystr_cache[source] | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.LatexManager |
get_width_height_descent(text, prop)[source]
Get the width, total height, and descent (in TeX points) for a text typeset by the current LaTeX environment. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.LatexManager.get_width_height_descent |
matplotlib.backends.backend_pgf.make_pdf_to_png_converter()[source]
Return a function that converts a pdf file to a png file. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.make_pdf_to_png_converter |
classmatplotlib.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
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. close()[source]
Finalize this object, running LaTeX in a temporary directory and moving the final pdf file to filename.
get_pagecount()[source]
Return the current number of pages in the multipage pdf file.
keep_empty
savefig(figure=None, **kwargs)[source]
Save a Figure to this file as a new page. Any other keyword arguments are passed to savefig. Parameters
figureFigure or int, default: the active figure
The figure, or index of the figure, that is saved to the file. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.PdfPages |
close()[source]
Finalize this object, running LaTeX in a temporary directory and moving the final pdf file to filename. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.PdfPages.close |
get_pagecount()[source]
Return the current number of pages in the multipage pdf file. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.PdfPages.get_pagecount |
keep_empty | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.PdfPages.keep_empty |
savefig(figure=None, **kwargs)[source]
Save a Figure to this file as a new page. Any other keyword arguments are passed to savefig. Parameters
figureFigure or int, default: the active figure
The figure, or index of the figure, that is saved to the file. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.PdfPages.savefig |
classmatplotlib.backends.backend_pgf.RendererPgf(figure, fh)[source]
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(gc, x, y, im, transform=None)[source]
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.
im(N, M, 4) array-like of 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(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
Draw a marker at each of path's vertices (excluding control points). 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(gc, path, transform, rgbFace=None)[source]
Draw a Path instance using the given affine transform.
draw_tex(gc, x, y, s, prop, angle, ismath='TeX', mtext=None)[source]
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
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()[source]
Return whether y values increase from top to bottom. Note that this only affects drawing of texts and images.
get_canvas_width_height()[source]
Return the canvas width and height in display coords.
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.
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
a float or a numpy array of float Returns
Points converted to pixels | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf |
draw_image(gc, x, y, im, transform=None)[source]
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.
im(N, M, 4) array-like of 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). | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.draw_image |
draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
Draw a marker at each of path's vertices (excluding control points). 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. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.draw_markers |
draw_path(gc, path, transform, rgbFace=None)[source]
Draw a Path instance using the given affine transform. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.draw_path |
draw_tex(gc, x, y, s, prop, angle, ismath='TeX', mtext=None)[source] | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.draw_tex |
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
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. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.draw_text |
flipy()[source]
Return whether y values increase from top to bottom. Note that this only affects drawing of texts and images. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.flipy |
get_canvas_width_height()[source]
Return the canvas width and height in display coords. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.get_canvas_width_height |
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. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.get_text_width_height_descent |
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"]. | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.option_image_nocomposite |
option_scale_image()[source]
Return whether arbitrary affine transformations in draw_image() are supported (True for most vector backends). | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.option_scale_image |
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
a float or a numpy array of float Returns
Points converted to pixels | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.RendererPgf.points_to_pixels |
classmatplotlib.backends.backend_pgf.TmpDirCleaner(*args, **kwargs)[source]
Bases: object [Deprecated] Notes Deprecated since version 3.4: staticadd(tmpdir)[source]
[Deprecated] Notes Deprecated since version 3.4:
staticcleanup_remaining_tmpdirs()[source]
[Deprecated] Notes Deprecated since version 3.4:
remaining_tmpdirs={} | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.TmpDirCleaner |
staticadd(tmpdir)[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.TmpDirCleaner.add |
staticcleanup_remaining_tmpdirs()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.TmpDirCleaner.cleanup_remaining_tmpdirs |
remaining_tmpdirs={} | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.TmpDirCleaner.remaining_tmpdirs |
matplotlib.backends.backend_pgf.writeln(fh, line)[source] | matplotlib.backend_pgf_api#matplotlib.backends.backend_pgf.writeln |
matplotlib.backends.backend_ps.convert_psfrags(tmpfile, psfrags, font_preamble, custom_preamble, paper_width, paper_height, orientation)[source]
When we want to use the LaTeX backend with postscript, we write PSFrag tags to a temporary postscript file, each one marking a position for LaTeX to render some text. convert_psfrags generates a LaTeX document containing the commands to convert those tags to text. LaTeX/dvips produces the postscript file that includes the actual text. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.convert_psfrags |
matplotlib.backends.backend_ps.FigureCanvas[source]
alias of matplotlib.backends.backend_ps.FigureCanvasPS | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvas |
classmatplotlib.backends.backend_ps.FigureCanvasPS(figure=None)[source]
Bases: matplotlib.backend_bases.FigureCanvasBase draw()[source]
Render the Figure. It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk.
filetypes={'eps': 'Encapsulated Postscript', 'ps': 'Postscript'}
fixed_dpi=72
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_eps(outfile, *args, **kwargs)[source]
print_ps(outfile, *args, **kwargs)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvasPS |
draw()[source]
Render the Figure. It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvasPS.draw |
filetypes={'eps': 'Encapsulated Postscript', 'ps': 'Postscript'} | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvasPS.filetypes |
fixed_dpi=72 | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvasPS.fixed_dpi |
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. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvasPS.get_default_filetype |
print_eps(outfile, *args, **kwargs)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvasPS.print_eps |
print_ps(outfile, *args, **kwargs)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.FigureCanvasPS.print_ps |
matplotlib.backends.backend_ps.get_bbox_header(lbrt, rotated=False)[source]
Return a postscript header string for the given bbox lbrt=(l, b, r, t). Optionally, return rotate command. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.get_bbox_header |
classmatplotlib.backends.backend_ps.GraphicsContextPS[source]
Bases: matplotlib.backend_bases.GraphicsContextBase [Deprecated] Notes Deprecated since version 3.4: get_capstyle()[source]
Return the CapStyle.
get_joinstyle()[source]
Return the JoinStyle. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.GraphicsContextPS |
get_capstyle()[source]
Return the CapStyle. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.GraphicsContextPS.get_capstyle |
get_joinstyle()[source]
Return the JoinStyle. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.GraphicsContextPS.get_joinstyle |
matplotlib.backends.backend_ps.gs_distill(tmpfile, eps=False, ptype='letter', bbox=None, rotated=False)[source]
Use ghostscript's pswrite or epswrite device to distill a file. This yields smaller files without illegal encapsulated postscript operators. The output is low-level, converting text to outlines. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.gs_distill |
classmatplotlib.backends.backend_ps.PsBackendHelper[source]
Bases: object | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.PsBackendHelper |
matplotlib.backends.backend_ps.pstoeps(tmpfile, bbox=None, rotated=False)[source]
Convert the postscript to encapsulated postscript. The bbox of the eps file will be replaced with the given bbox argument. If None, original bbox will be used. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.pstoeps |
matplotlib.backends.backend_ps.quote_ps_string(s)[source]
Quote dangerous characters of S for use in a PostScript string constant. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.quote_ps_string |
classmatplotlib.backends.backend_ps.RendererPS(width, height, pswriter, imagedpi=72)[source]
Bases: matplotlib.backends._backend_pdf_ps.RendererPDFPSBase The renderer handles all the drawing primitives using a graphics context instance that controls the colors/styles. create_hatch(hatch)[source]
draw_gouraud_triangle(gc, points, colors, trans)[source]
Draw a Gouraud-shaded triangle. Parameters
gcGraphicsContextBase
The graphics context.
points(3, 2) array-like
Array of (x, y) points for the triangle.
colors(3, 4) array-like
RGBA colors for each point of the triangle.
transformmatplotlib.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(N, 3, 2) array-like
Array of N (x, y) points for the triangles.
colors(N, 3, 4) array-like
Array of N RGBA colors for each point of the triangles.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points.
draw_image(gc, x, y, im, transform=None)[source]
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.
im(N, M, 4) array-like of 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(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
Draw a marker at each of path's vertices (excluding control points). 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_mathtext(gc, x, y, s, prop, angle)[source]
Draw the math text using matplotlib.mathtext.
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 is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_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 of draw_path_collection() can be made globally.
draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
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.
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.
propertymathtext_parser[source]
set_color(r, g, b, store=True)[source]
set_font(fontname, fontsize, store=True)[source]
set_linecap(linecap, store=True)[source]
set_linedash(offset, seq, store=True)[source]
set_linejoin(linejoin, store=True)[source]
set_linewidth(linewidth, store=True)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS |
create_hatch(hatch)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.create_hatch |
draw_gouraud_triangle(gc, points, colors, trans)[source]
Draw a Gouraud-shaded triangle. Parameters
gcGraphicsContextBase
The graphics context.
points(3, 2) array-like
Array of (x, y) points for the triangle.
colors(3, 4) array-like
RGBA colors for each point of the triangle.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_gouraud_triangle |
draw_gouraud_triangles(gc, points, colors, trans)[source]
Draw a series of Gouraud triangles. Parameters
points(N, 3, 2) array-like
Array of N (x, y) points for the triangles.
colors(N, 3, 4) array-like
Array of N RGBA colors for each point of the triangles.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_gouraud_triangles |
draw_image(gc, x, y, im, transform=None)[source]
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.
im(N, M, 4) array-like of 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). | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_image |
draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
Draw a marker at each of path's vertices (excluding control points). 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. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_markers |
draw_mathtext(gc, x, y, s, prop, angle)[source]
Draw the math text using matplotlib.mathtext. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_mathtext |
draw_path(gc, path, transform, rgbFace=None)[source]
Draw a Path instance using the given affine transform. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_path |
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 is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_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 of draw_path_collection() can be made globally. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_path_collection |
draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_tex |
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
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. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.draw_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. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.get_image_magnification |
set_color(r, g, b, store=True)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.set_color |
set_font(fontname, fontsize, store=True)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.set_font |
set_linecap(linecap, store=True)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.set_linecap |
set_linedash(offset, seq, store=True)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.set_linedash |
set_linejoin(linejoin, store=True)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.set_linejoin |
set_linewidth(linewidth, store=True)[source] | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.RendererPS.set_linewidth |
matplotlib.backends.backend_ps.xpdf_distill(tmpfile, eps=False, ptype='letter', bbox=None, rotated=False)[source]
Use ghostscript's ps2pdf and xpdf's/poppler's pdftops to distill a file. This yields smaller files without illegal encapsulated postscript operators. This distiller is preferred, generating high-level postscript output that treats text as text. | matplotlib.backend_ps_api#matplotlib.backends.backend_ps.xpdf_distill |
matplotlib.backends.backend_svg.escape_attrib(s)[source] | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.escape_attrib |
matplotlib.backends.backend_svg.escape_cdata(s)[source] | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.escape_cdata |
matplotlib.backends.backend_svg.escape_comment(s)[source] | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.escape_comment |
matplotlib.backends.backend_svg.FigureCanvas[source]
alias of matplotlib.backends.backend_svg.FigureCanvasSVG | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvas |
classmatplotlib.backends.backend_svg.FigureCanvasSVG(figure=None)[source]
Bases: matplotlib.backend_bases.FigureCanvasBase draw()[source]
Render the Figure. It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk.
filetypes={'svg': 'Scalable Vector Graphics', 'svgz': 'Scalable Vector Graphics'}
fixed_dpi=72
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_svg(filename, *args, dpi=<deprecated parameter>, bbox_inches_restore=None, metadata=None)[source]
Parameters
filenamestr or path-like or file-like
Output target; if a string, a file will be opened for writing.
metadatadict[str, Any], optional
Metadata in the SVG file defined as key-value pairs of strings, datetimes, or lists of strings, e.g., {'Creator': 'My software',
'Contributor': ['Me', 'My Friend'], 'Title': 'Awesome'}. The standard keys and their value types are:
str: 'Coverage', 'Description', 'Format', 'Identifier', 'Language', 'Relation', 'Source', 'Title', and 'Type'.
str or list of str: 'Contributor', 'Creator', 'Keywords', 'Publisher', and 'Rights'.
str, date, datetime, or tuple of same: 'Date'. If a non-str, then it will be formatted as ISO 8601. Values have been predefined for 'Creator', 'Date', 'Format', and 'Type'. They can be removed by setting them to None. Information is encoded as Dublin Core Metadata.
print_svgz(filename, *args, **kwargs)[source] | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvasSVG |
draw()[source]
Render the Figure. It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk. | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvasSVG.draw |
filetypes={'svg': 'Scalable Vector Graphics', 'svgz': 'Scalable Vector Graphics'} | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvasSVG.filetypes |
fixed_dpi=72 | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvasSVG.fixed_dpi |
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. | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvasSVG.get_default_filetype |
print_svg(filename, *args, dpi=<deprecated parameter>, bbox_inches_restore=None, metadata=None)[source]
Parameters
filenamestr or path-like or file-like
Output target; if a string, a file will be opened for writing.
metadatadict[str, Any], optional
Metadata in the SVG file defined as key-value pairs of strings, datetimes, or lists of strings, e.g., {'Creator': 'My software',
'Contributor': ['Me', 'My Friend'], 'Title': 'Awesome'}. The standard keys and their value types are:
str: 'Coverage', 'Description', 'Format', 'Identifier', 'Language', 'Relation', 'Source', 'Title', and 'Type'.
str or list of str: 'Contributor', 'Creator', 'Keywords', 'Publisher', and 'Rights'.
str, date, datetime, or tuple of same: 'Date'. If a non-str, then it will be formatted as ISO 8601. Values have been predefined for 'Creator', 'Date', 'Format', and 'Type'. They can be removed by setting them to None. Information is encoded as Dublin Core Metadata. | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvasSVG.print_svg |
print_svgz(filename, *args, **kwargs)[source] | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.FigureCanvasSVG.print_svgz |
matplotlib.backends.backend_svg.generate_css(attrib={})[source] | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.generate_css |
matplotlib.backends.backend_svg.generate_transform(transform_list=[])[source] | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.generate_transform |
classmatplotlib.backends.backend_svg.RendererSVG(width, height, svgwriter, basename=None, image_dpi=72, *, metadata=None)[source]
Bases: matplotlib.backend_bases.RendererBase close_group(s)[source]
Close a grouping element with label s. Only used by the SVG renderer.
draw_gouraud_triangle(gc, points, colors, trans)[source]
Draw a Gouraud-shaded triangle. Parameters
gcGraphicsContextBase
The graphics context.
points(3, 2) array-like
Array of (x, y) points for the triangle.
colors(3, 4) array-like
RGBA colors for each point of the triangle.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points.
draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[source]
Draw a series of Gouraud triangles. Parameters
points(N, 3, 2) array-like
Array of N (x, y) points for the triangles.
colors(N, 3, 4) array-like
Array of N RGBA colors for each point of the triangles.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points.
draw_image(gc, x, y, im, transform=None)[source]
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.
im(N, M, 4) array-like of 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(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
Draw a marker at each of path's vertices (excluding control points). 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(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 is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_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 of draw_path_collection() can be made globally.
draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
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.
finalize()[source]
flipy()[source]
Return whether y values increase from top to bottom. Note that this only affects drawing of texts and images.
get_canvas_width_height()[source]
Return the canvas width and height in display coords.
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.
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.
propertymathtext_parser[source]
open_group(s, gid=None)[source]
Open a grouping element with label s and gid (if set) as id. Only used by the SVG renderer.
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). | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.RendererSVG |
close_group(s)[source]
Close a grouping element with label s. Only used by the SVG renderer. | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.RendererSVG.close_group |
draw_gouraud_triangle(gc, points, colors, trans)[source]
Draw a Gouraud-shaded triangle. Parameters
gcGraphicsContextBase
The graphics context.
points(3, 2) array-like
Array of (x, y) points for the triangle.
colors(3, 4) array-like
RGBA colors for each point of the triangle.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points. | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.RendererSVG.draw_gouraud_triangle |
draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[source]
Draw a series of Gouraud triangles. Parameters
points(N, 3, 2) array-like
Array of N (x, y) points for the triangles.
colors(N, 3, 4) array-like
Array of N RGBA colors for each point of the triangles.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points. | matplotlib.backend_svg_api#matplotlib.backends.backend_svg.RendererSVG.draw_gouraud_triangles |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.