matplotlib.backends.backend_cairo#

matplotlib.backends.backend_cairo.FigureCanvas[source]#

alias ofFigureCanvasCairo

classmatplotlib.backends.backend_cairo.FigureCanvasCairo(figure=None)[source]#

Bases:FigureCanvasBase

copy_from_bbox(bbox)[source]#

get_renderer()[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]#

classmatplotlib.backends.backend_cairo.GraphicsContextCairo(renderer)[source]#

Bases:GraphicsContextBase

get_antialiased()[source]#

Return whether the object should try to do antialiased rendering.

get_rgb()[source]#

Return a tuple of three or four floats from 0-1.

restore()[source]#

Restore the graphics context from the stack - needed onlyfor backends that save graphics contexts on a stack.

set_alpha(alpha)[source]#

Set the alpha value used for blending - not supported on all backends.

Ifalpha=None (the default), the alpha components of theforeground and fill colors will be used to set their respectivetransparencies (where applicable); otherwise,alpha will overridethem.

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 aTransformedPath or None.

set_clip_rectangle(rectangle)[source]#

Set the clip rectangle to aBbox or None.

set_dashes(offset,dashes)[source]#

Set the dash style for the gc.

Parameters:

dash_offsetfloat

Distance, in points, into the dash pattern at which tostart the pattern. It is usually set to 0.

dash_listarray-like or None

The on-off sequence as points. None specifies a solid line. Allvalues must otherwise be non-negative (\(\ge 0\)).

Notes

See p. 666 of the PostScriptLanguage Referencefor more info.

set_foreground(fg,isRGBA=None)[source]#

Set the foreground color.

Parameters:

fgcolor

isRGBAbool

Iffg is known to be an(r,g,b,a) tuple,isRGBA can beset 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.

classmatplotlib.backends.backend_cairo.RendererCairo(dpi)[source]#

Bases:RendererBase

draw_image(gc,x,y,im)[source]#

Draw an RGBA image.

Parameters:

gcGraphicsContextBase

A graphics context with clipping information.

xfloat

The distance in physical units (i.e., dots or pixels) from the lefthand side of the canvas.

yfloat

The distance in physical units (i.e., dots or pixels) from thebottom side of the canvas.

im(N, M, 4) array ofnumpy.uint8

An array of RGBA pixels.

transformAffine2DBase

If and only if the concrete backend is written such thatoption_scale_image returnsTrue, an affine transformation(i.e., anAffine2DBase)may be passed todraw_image. Thetranslation vector of the transformation is given in physical units(i.e., dots or pixels). Note that the transformation does notoverridex andy, and has to be appliedbefore translatingthe result byx andy (this can be accomplished by addingxandy to the translation vector defined bytransform).

draw_markers(gc,marker_path,marker_trans,path,transform,rgbFace=None)[source]#

Draw a marker at each ofpath's vertices (excluding control points).

The base (fallback) implementation makes multiple calls todraw_path.Backends may want to override this method in order to draw the markeronly once and reuse it multiple times.

Parameters:

gcGraphicsContextBase

The graphics context.

marker_pathPath

The path for the marker.

marker_transTransform

An affine transform applied to the marker.

pathPath

The locations to draw the markers.

transTransform

An affine transform applied to the path.

rgbFacecolor, optional

draw_path(gc,path,transform,rgbFace=None)[source]#

Draw aPath instance using the given affine transform.

draw_text(gc,x,y,s,prop,angle,ismath=False,mtext=None)[source]#

Draw a 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.

propFontProperties

The font properties.

anglefloat

The rotation angle in degrees anti-clockwise.

ismathbool or "TeX"

If True, use mathtext parser.

mtextText

The original text object to be rendered.

Notes

Notes for backend implementers:

RendererBase.draw_text also supports passing "TeX" to theismathparameter to use TeX rendering, but this is not required for actualrendering backends, and indeed many builtin backends do not supportthis. Rather, TeX rendering is provided bydraw_tex.

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), indisplay coords, of the strings withFontPropertiesprop.

Whitespace at the start and the end ofs is included in the reported width.

new_gc()[source]#

Return an instance of aGraphicsContextBase.

points_to_pixels(points)[source]#

Convert points to display units.

You need to override this function (unless your backenddoesn't have a dpi, e.g., postscript or svg). Some imagingsystems assume some value for pixels per inch:

pointstopixels=points*pixels_per_inch/72*dpi/72

Parameters:

pointsfloat or array-like

Returns:

Points converted to pixels

set_context(ctx)[source]#