doc_content
stringlengths
1
386k
doc_id
stringlengths
5
188
tostring_rgba_minimized()[source] [Deprecated] Notes Deprecated since version 3.4:
matplotlib.backend_agg_api#matplotlib.backends.backend_agg.RendererAgg.tostring_rgba_minimized
matplotlib.backends.backend_cairo.FigureCanvas[source] alias of matplotlib.backends.backend_cairo.FigureCanvasCairo
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvas
classmatplotlib.backends.backend_cairo.FigureCanvasCairo(figure=None)[source] Bases: matplotlib.backend_bases.FigureCanvasBase copy_from_bbox(bbox)[source] print_pdf(fobj, *, orientation='portrait') print_png(fobj)[source] print_ps(fobj, *, orientation='portrait') print_raw(fobj)[source] print_rgba(fobj)[source] print_svg(fobj, *, orientation='portrait') print_svgz(fobj, *, orientation='portrait') restore_region(region)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo
copy_from_bbox(bbox)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.copy_from_bbox
print_pdf(fobj, *, orientation='portrait')
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_pdf
print_png(fobj)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_png
print_ps(fobj, *, orientation='portrait')
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_ps
print_raw(fobj)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_raw
print_rgba(fobj)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_rgba
print_svg(fobj, *, orientation='portrait')
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_svg
print_svgz(fobj, *, orientation='portrait')
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_svgz
restore_region(region)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.FigureCanvasCairo.restore_region
classmatplotlib.backends.backend_cairo.GraphicsContextCairo(renderer)[source] Bases: matplotlib.backend_bases.GraphicsContextBase get_rgb()[source] Return a tuple of three or four floats from 0-1. restore()[source] Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack. set_alpha(alpha)[source] Set the alpha value used for blending - not supported on all backends. If alpha=None (the default), the alpha components of the foreground and fill colors will be used to set their respective transparencies (where applicable); otherwise, alpha will override them. set_antialiased(b)[source] Set whether object should be drawn with antialiased rendering. set_capstyle(cs)[source] Set how to draw endpoints of lines. Parameters csCapStyle or {'butt', 'projecting', 'round'} set_clip_path(path)[source] Set the clip path to a TransformedPath or None. set_clip_rectangle(rectangle)[source] Set the clip rectangle to a Bbox or None. set_dashes(offset, dashes)[source] Set the dash style for the gc. Parameters dash_offsetfloat The offset (usually 0). dash_listarray-like or None The on-off sequence as points. None specifies a solid line. Notes See p. 107 of to PostScript blue book for more info. set_foreground(fg, isRGBA=None)[source] Set the foreground color. Parameters fgcolor isRGBAbool If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance. set_joinstyle(js)[source] Set how to draw connections between line segments. Parameters jsJoinStyle or {'miter', 'round', 'bevel'} set_linewidth(w)[source] Set the linewidth in points.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo
get_rgb()[source] Return a tuple of three or four floats from 0-1.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.get_rgb
restore()[source] Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.restore
set_alpha(alpha)[source] Set the alpha value used for blending - not supported on all backends. If alpha=None (the default), the alpha components of the foreground and fill colors will be used to set their respective transparencies (where applicable); otherwise, alpha will override them.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_alpha
set_antialiased(b)[source] Set whether object should be drawn with antialiased rendering.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_antialiased
set_capstyle(cs)[source] Set how to draw endpoints of lines. Parameters csCapStyle or {'butt', 'projecting', 'round'}
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_capstyle
set_clip_path(path)[source] Set the clip path to a TransformedPath or None.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_clip_path
set_clip_rectangle(rectangle)[source] Set the clip rectangle to a Bbox or None.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_clip_rectangle
set_dashes(offset, dashes)[source] Set the dash style for the gc. Parameters dash_offsetfloat The offset (usually 0). dash_listarray-like or None The on-off sequence as points. None specifies a solid line. Notes See p. 107 of to PostScript blue book for more info.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_dashes
set_foreground(fg, isRGBA=None)[source] Set the foreground color. Parameters fgcolor isRGBAbool If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_foreground
set_joinstyle(js)[source] Set how to draw connections between line segments. Parameters jsJoinStyle or {'miter', 'round', 'bevel'}
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_joinstyle
set_linewidth(w)[source] Set the linewidth in points.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_linewidth
classmatplotlib.backends.backend_cairo.RendererCairo(dpi)[source] Bases: matplotlib.backend_bases.RendererBase draw_image(gc, x, y, im)[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, transform, 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_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_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. propertymathtext_parser[source] new_gc()[source] Return an instance of a GraphicsContextBase. 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 set_ctx_from_surface(surface)[source] set_width_height(width, height)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.RendererCairo
draw_image(gc, x, y, im)[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_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.draw_image
draw_markers(gc, marker_path, marker_trans, path, transform, 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_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.draw_markers
draw_path(gc, path, transform, rgbFace=None)[source] Draw a Path instance using the given affine transform.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.draw_path
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_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.draw_text
get_canvas_width_height()[source] Return the canvas width and height in display coords.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.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_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.get_text_width_height_descent
new_gc()[source] Return an instance of a GraphicsContextBase.
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.new_gc
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_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.points_to_pixels
set_ctx_from_surface(surface)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.set_ctx_from_surface
set_width_height(width, height)[source]
matplotlib.backend_cairo_api#matplotlib.backends.backend_cairo.RendererCairo.set_width_height
classmatplotlib.backends.backend_mixed.MixedModeRenderer(figure, width, height, dpi, vector_renderer, raster_renderer_class=None, bbox_inches_restore=None)[source] Bases: object A helper class to implement a renderer that switches between vector and raster drawing. An example may be a PDF writer, where most things are drawn with PDF vector commands, but some very complex objects, such as quad meshes, are rasterised and then output as images. Parameters figurematplotlib.figure.Figure The figure instance. widthscalar The width of the canvas in logical units heightscalar The height of the canvas in logical units dpifloat The dpi of the canvas vector_renderermatplotlib.backend_bases.RendererBase An instance of a subclass of RendererBase that will be used for the vector drawing. raster_renderer_classmatplotlib.backend_bases.RendererBase The renderer class to use for the raster drawing. If not provided, this will use the Agg backend (which is currently the only viable option anyway.) start_rasterizing()[source] Enter "raster" mode. All subsequent drawing commands (until stop_rasterizing is called) will be drawn with the raster backend. stop_rasterizing()[source] Exit "raster" mode. All of the drawing that was done since the last start_rasterizing call will be copied to the vector backend by calling draw_image.
matplotlib.backend_mixed_api#matplotlib.backends.backend_mixed.MixedModeRenderer
start_rasterizing()[source] Enter "raster" mode. All subsequent drawing commands (until stop_rasterizing is called) will be drawn with the raster backend.
matplotlib.backend_mixed_api#matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing
stop_rasterizing()[source] Exit "raster" mode. All of the drawing that was done since the last start_rasterizing call will be copied to the vector backend by calling draw_image.
matplotlib.backend_mixed_api#matplotlib.backends.backend_mixed.MixedModeRenderer.stop_rasterizing
classmatplotlib.backends.backend_nbagg.CommSocket(manager)[source] Bases: object Manages the Comm connection between IPython and the browser (client). Comms are 2 way, with the CommSocket being able to publish a message via the send_json method, and handle a message with on_message. On the JS side figure.send_message and figure.ws.onmessage do the sending and receiving respectively. is_open()[source] on_close()[source] on_message(message)[source] send_binary(blob)[source] send_json(content)[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.CommSocket
is_open()[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.CommSocket.is_open
on_close()[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.CommSocket.on_close
on_message(message)[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.CommSocket.on_message
send_binary(blob)[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.CommSocket.send_binary
send_json(content)[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.CommSocket.send_json
matplotlib.backends.backend_nbagg.connection_info()[source] Return a string showing the figure and connection status for the backend. This is intended as a diagnostic tool, and not for general use.
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.connection_info
matplotlib.backends.backend_nbagg.FigureCanvas[source] alias of matplotlib.backends.backend_nbagg.FigureCanvasNbAgg
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureCanvas
classmatplotlib.backends.backend_nbagg.FigureCanvasNbAgg(*args, **kwargs)[source] Bases: matplotlib.backends.backend_webagg_core.FigureCanvasWebAggCore
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureCanvasNbAgg
matplotlib.backends.backend_nbagg.FigureManager[source] alias of matplotlib.backends.backend_nbagg.FigureManagerNbAgg
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManager
classmatplotlib.backends.backend_nbagg.FigureManagerNbAgg(canvas, num)[source] Bases: matplotlib.backends.backend_webagg_core.FigureManagerWebAgg ToolbarCls[source] alias of matplotlib.backends.backend_nbagg.NavigationIPy clearup_closed()[source] Clear up any closed Comms. propertyconnected destroy()[source] display_js()[source] classmethodget_javascript(stream=None)[source] remove_comm(comm_id)[source] reshow()[source] A special method to re-show the figure in the notebook. show()[source] For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg
clearup_closed()[source] Clear up any closed Comms.
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.clearup_closed
destroy()[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.destroy
display_js()[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.display_js
classmethodget_javascript(stream=None)[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.get_javascript
remove_comm(comm_id)[source]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.remove_comm
reshow()[source] A special method to re-show the figure in the notebook.
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.reshow
show()[source] For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.show
ToolbarCls[source] alias of matplotlib.backends.backend_nbagg.NavigationIPy
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.ToolbarCls
classmatplotlib.backends.backend_nbagg.NavigationIPy(canvas)[source] Bases: matplotlib.backends.backend_webagg_core.NavigationToolbar2WebAgg toolitems=[('Home', 'Reset original view', 'fa fa-home icon-home', 'home'), ('Back', 'Back to previous view', 'fa fa-arrow-left icon-arrow-left', 'back'), ('Forward', 'Forward to next view', 'fa fa-arrow-right icon-arrow-right', 'forward'), (None, None, None, None), ('Pan', 'Left button pans, Right button zooms\nx/y fixes axis, CTRL fixes aspect', 'fa fa-arrows icon-move', 'pan'), ('Zoom', 'Zoom to rectangle\nx/y fixes axis', 'fa fa-square-o icon-check-empty', 'zoom'), (None, None, None, None), ('Download', 'Download plot', 'fa fa-floppy-o icon-save', 'download')]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.NavigationIPy
toolitems=[('Home', 'Reset original view', 'fa fa-home icon-home', 'home'), ('Back', 'Back to previous view', 'fa fa-arrow-left icon-arrow-left', 'back'), ('Forward', 'Forward to next view', 'fa fa-arrow-right icon-arrow-right', 'forward'), (None, None, None, None), ('Pan', 'Left button pans, Right button zooms\nx/y fixes axis, CTRL fixes aspect', 'fa fa-arrows icon-move', 'pan'), ('Zoom', 'Zoom to rectangle\nx/y fixes axis', 'fa fa-square-o icon-check-empty', 'zoom'), (None, None, None, None), ('Download', 'Download plot', 'fa fa-floppy-o icon-save', 'download')]
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.NavigationIPy.toolitems
matplotlib.backends.backend_nbagg.new_figure_manager_given_figure(num, figure)[source] Create a new figure manager instance for the given figure.
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.new_figure_manager_given_figure
matplotlib.backends.backend_nbagg.show(block=None)[source] Show all figures. show blocks by calling mainloop if block is True, or if it is None and we are neither in IPython's %pylab mode, nor in interactive mode.
matplotlib.backend_nbagg_api#matplotlib.backends.backend_nbagg.show
matplotlib.backends.backend_pdf.FigureCanvas[source] alias of matplotlib.backends.backend_pdf.FigureCanvasPdf
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.FigureCanvas
classmatplotlib.backends.backend_pdf.FigureCanvasPdf(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': 'Portable Document Format'} 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_pdf(filename, *, dpi=<deprecated parameter>, bbox_inches_restore=None, metadata=None)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.FigureCanvasPdf
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_pdf_api#matplotlib.backends.backend_pdf.FigureCanvasPdf.draw
filetypes={'pdf': 'Portable Document Format'}
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.FigureCanvasPdf.filetypes
fixed_dpi=72
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.FigureCanvasPdf.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_pdf_api#matplotlib.backends.backend_pdf.FigureCanvasPdf.get_default_filetype
print_pdf(filename, *, dpi=<deprecated parameter>, bbox_inches_restore=None, metadata=None)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.FigureCanvasPdf.print_pdf
matplotlib.backends.backend_pdf.fill(strings, linelen=75)[source] Make one string from sequence of strings, with whitespace in between. The whitespace is chosen to form lines of at most linelen characters, if possible.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.fill
classmatplotlib.backends.backend_pdf.GraphicsContextPdf(file)[source] Bases: matplotlib.backend_bases.GraphicsContextBase alpha_cmd(alpha, forced, effective_alphas)[source] capstyle_cmd(style)[source] capstyles={'butt': 0, 'projecting': 2, 'round': 1} clip_cmd(cliprect, clippath)[source] Set clip rectangle. Calls pop() and push(). 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>)) copy_properties(other)[source] Copy properties of other into self. dash_cmd(dashes)[source] 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. fillcolor_cmd(rgb)[source] finalize()[source] Make sure every pushed graphics state is popped. hatch_cmd(hatch, hatch_color)[source] joinstyle_cmd(style)[source] joinstyles={'bevel': 2, 'miter': 0, 'round': 1} linewidth_cmd(width)[source] paint()[source] Return the appropriate pdf operator to cause the path to be stroked, filled, or both. pop()[source] push()[source] rgb_cmd(rgb)[source] stroke()[source] Predicate: does the path need to be stroked (its outline drawn)? This tests for the various conditions that disable stroking the path, in which case it would presumably be filled.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf
alpha_cmd(alpha, forced, effective_alphas)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.alpha_cmd
capstyle_cmd(style)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyle_cmd
capstyles={'butt': 0, 'projecting': 2, 'round': 1}
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.capstyles
clip_cmd(cliprect, clippath)[source] Set clip rectangle. Calls pop() and push().
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.clip_cmd
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>))
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.commands
copy_properties(other)[source] Copy properties of other into self.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.copy_properties
dash_cmd(dashes)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.dash_cmd
delta(other)[source] Copy properties of other into self and return PDF commands needed to transform self into other.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.delta
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.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.fill
fillcolor_cmd(rgb)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.fillcolor_cmd
finalize()[source] Make sure every pushed graphics state is popped.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.finalize
hatch_cmd(hatch, hatch_color)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.hatch_cmd
joinstyle_cmd(style)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyle_cmd
joinstyles={'bevel': 2, 'miter': 0, 'round': 1}
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.joinstyles
linewidth_cmd(width)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.linewidth_cmd
paint()[source] Return the appropriate pdf operator to cause the path to be stroked, filled, or both.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.paint
pop()[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.pop
push()[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.push
rgb_cmd(rgb)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.rgb_cmd
stroke()[source] Predicate: does the path need to be stroked (its outline drawn)? This tests for the various conditions that disable stroking the path, in which case it would presumably be filled.
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.GraphicsContextPdf.stroke
classmatplotlib.backends.backend_pdf.Name(name)[source] Bases: object PDF name object. statichexify(match)[source] name pdfRepr()[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Name
statichexify(match)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Name.hexify
name
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Name.name
pdfRepr()[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Name.pdfRepr
classmatplotlib.backends.backend_pdf.Op(value)[source] Bases: matplotlib.backends.backend_pdf.Operator, enum.Enum An enumeration. begin_text=(b'BT',)[source] clip=b'W'[source] close_fill_stroke=b'b'[source] close_stroke=b's'[source] closepath=(b'h',)[source] concat_matrix=b'cm'[source] curveto=b'c'[source] end_text=b'ET'[source] endpath=b'n'[source] fill=b'f'[source] fill_stroke=b'B'[source] grestore=b'Q'[source] gsave=(b'q',)[source] lineto=b'l'[source] moveto=(b'm',)[source] op classmethodpaint_path(fill, stroke)[source] Return the PDF operator to paint a path. Parameters fillbool Fill the path with the fill color. strokebool Stroke the outline of the path with the line color. rectangle=b're'[source] selectfont=b'Tf'[source] setcolor_nonstroke=b'scn'[source] setcolor_stroke=b'SCN'[source] setcolorspace_nonstroke=(b'cs',)[source] setcolorspace_stroke=b'CS'[source] setdash=(b'd',)[source] setgray_nonstroke=b'g'[source] setgray_stroke=(b'G',)[source] setgstate=b'gs'[source] setlinecap=b'J'[source] setlinejoin=b'j'[source] setlinewidth=b'w'[source] setrgb_nonstroke=(b'rg',)[source] setrgb_stroke=b'RG'[source] shading=b'sh'[source] show=b'Tj'[source] showkern=b'TJ'[source] stroke=b'S'[source] textmatrix=(b'Tm',)[source] textpos=b'Td'[source] use_xobject=b'Do'[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Op
begin_text=(b'BT',)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Op.begin_text
clip=b'W'[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Op.clip
close_fill_stroke=b'b'[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Op.close_fill_stroke
close_stroke=b's'[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Op.close_stroke
closepath=(b'h',)[source]
matplotlib.backend_pdf_api#matplotlib.backends.backend_pdf.Op.closepath