Author: | Steve Chaplin and others |
---|
This backend depends on cairocffi or pycairo.
class matplotlib.backends.backend_cairo.ArrayWrapper(**kwargs)
[source]
Bases: object
Deprecated since version 3.0: The ArrayWrapper class was deprecated in Matplotlib 3.0 and will be removed in 3.2.
buffer_info()
[source]
matplotlib.backends.backend_cairo.FigureCanvas
alias of matplotlib.backends.backend_cairo.FigureCanvasCairo
class matplotlib.backends.backend_cairo.FigureCanvasCairo(figure)
[source]
Bases: matplotlib.backend_bases.FigureCanvasBase
print_pdf(fobj, *args, **kwargs)
[source]
print_png(fobj, *args, **kwargs)
[source]
print_ps(fobj, *args, **kwargs)
[source]
print_raw(fobj, *args, **kwargs)
print_rgba(fobj, *args, **kwargs)
[source]
print_svg(fobj, *args, **kwargs)
[source]
print_svgz(fobj, *args, **kwargs)
[source]
supports_blit = False
class matplotlib.backends.backend_cairo.GraphicsContextCairo(renderer)
[source]
Bases: matplotlib.backend_bases.GraphicsContextBase
get_rgb()
[source]
returns 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_capstyle(cs)
[source]
Set the capstyle as a string in ('butt', 'round', 'projecting')
set_clip_path(path)
[source]
Set the clip path and transformation. Path should be a TransformedPath
instance.
set_clip_rectangle(rectangle)
[source]
Set the clip rectangle with sequence (left, bottom, width, height)
set_dashes(offset, dashes)
[source]
Set the dash style for the gc.
Parameters: |
|
---|
set_foreground(fg, isRGBA=None)
[source]
Set the foreground color. fg can be a MATLAB format string, a html hex color string, an rgb or rgba unit tuple, or a float between 0 and 1. In the latter case, grayscale is used.
If you know fg is rgba, set isRGBA=True
for efficiency.
set_joinstyle(js)
[source]
Set the join style to be one of ('miter', 'round', 'bevel')
set_linewidth(w)
[source]
Set the linewidth in points
class matplotlib.backends.backend_cairo.RendererCairo(dpi)
[source]
Bases: matplotlib.backend_bases.RendererBase
static convert_path(ctx, path, transform, clip=None)
[source]
Deprecated since version 3.0: The convert_path function was deprecated in Matplotlib 3.0 and will be removed in 3.2.
draw_image(gc, x, y, im)
[source]
Draw an RGBA image.
Parameters: |
|
---|
draw_markers(gc, marker_path, marker_trans, path, transform, rgbFace=None)
[source]
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: |
|
---|
draw_path(gc, path, transform, rgbFace=None)
[source]
Draws 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]
Draws 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 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_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)
[source]
Draw the text instance
Parameters: |
|
---|
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.
fontangles = {'italic': <MyCairoCffi name='mock.FONT_SLANT_ITALIC' id='140354934147336'>, 'normal': <MyCairoCffi name='mock.FONT_SLANT_NORMAL' id='140354934155752'>, 'oblique': <MyCairoCffi name='mock.FONT_SLANT_OBLIQUE' id='140354934172360'>}
fontweights = {100: <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 200: <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 300: <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 400: <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 500: <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 600: <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 700: <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 800: <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 900: <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 'ultralight': <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 'light': <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 'normal': <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 'medium': <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 'regular': <MyCairoCffi name='mock.FONT_WEIGHT_NORMAL' id='140354934118216'>, 'semibold': <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 'bold': <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 'heavy': <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 'ultrabold': <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>, 'black': <MyCairoCffi name='mock.FONT_WEIGHT_BOLD' id='140354934134824'>}
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
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.0 * dpi/72.0
Parameters: |
|
---|---|
Returns: |
|
set_ctx_from_surface(surface)
[source]
set_width_height(width, height)
[source]
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.0.0/api/backend_cairo_api.html