@header@
 
 
matplotlib.backends.backend_cairo
index
/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/backends/backend_cairo.py

A Cairo backend for matplotlib
Author: Steve Chaplin
 
Cairo is a vector graphics library with cross-device output support.
Features of Cairo:
 * anti-aliasing
 * alpha channel
 * saves image files as PNG, PostScript, PDF
 
http://cairographics.org
Requires (in order, all available from Cairo website):
    cairo, pycairo
 
Naming Conventions
  * classes MixedUpperCase
  * varables lowerUpper
  * functions underscore_separated

 
Modules
       
cairo
gzip
numpy
os
sys
warnings

 
Classes
       
matplotlib.backend_bases.FigureCanvasBase
FigureCanvasCairo
matplotlib.backend_bases.GraphicsContextBase
GraphicsContextCairo
matplotlib.backend_bases.RendererBase
RendererCairo

 
class FigureCanvasCairo(matplotlib.backend_bases.FigureCanvasBase)
     Methods defined here:
get_default_filetype(self)
print_pdf(self, fobj, *args, **kwargs)
print_png(self, fobj, *args, **kwargs)
print_ps(self, fobj, *args, **kwargs)
print_svg(self, fobj, *args, **kwargs)
print_svgz(self, fobj, *args, **kwargs)

Methods inherited from matplotlib.backend_bases.FigureCanvasBase:
__init__(self, figure)
blit(self, bbox=None)
blit the canvas in bbox (default entire canvas)
button_press_event(self, x, y, button, guiEvent=None)
Backend derived classes should call this function on any mouse
button press.  x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
button_release_event(self, x, y, button, guiEvent=None)
Backend derived classes should call this function on any mouse
button release.  x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
draw(self, *args, **kwargs)
Render the figure
draw_cursor(self, event)
Draw a cursor in the event.axes if inaxes is not None.  Use
native GUI drawing for efficiency if possible
draw_event(self, renderer)
draw_idle(self, *args, **kwargs)
draw only if idle; defaults to draw but backends can overrride
flush_events(self)
Flush the GUI events for the figure. Implemented only for
backends with GUIs.
get_supported_filetypes(self)
get_supported_filetypes_grouped(self)
get_width_height(self)
return the figure width and height in points or pixels
(depending on the backend), truncated to integers
key_press_event(self, key, guiEvent=None)
key_release_event(self, key, guiEvent=None)
motion_notify_event(self, x, y, guiEvent=None)
Backend derived classes should call this function on any
motion-notify-event. x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
mpl_connect(self, s, func)
Connect event with string s to func.  The signature of func is
 
  def func(event)
 
where event is a MplEvent.  The following events are recognized
 
'resize_event',
'draw_event',
'key_press_event',
'key_release_event',
'button_press_event',
'button_release_event',
'scroll_event',
'motion_notify_event',
'pick_event',
 
 
For the three events above, if the mouse is over the axes,
the variable event.inaxes will be set to the axes it is over,
and additionally, the variables event.xdata and event.ydata
will be defined.  This is the mouse location in data coords.
See backend_bases.MplEvent.
 
return value is a connection id that can be used with
mpl_disconnect
mpl_disconnect(self, cid)
disconnect callback id cid
onHilite(self, ev)
Mouse event processor which highlights the artists
under the cursor.  Connect this to the motion_notify_event
using canvas.mpl_connect('motion_notify_event',canvas.onHilite)
onRemove(self, ev)
Mouse event processor which removes the top artist
under the cursor.  Connect this to the mouse_press_event
using canvas.mpl_connect('mouse_press_event',canvas.onRemove)
pick(self, mouseevent)
pick_event(self, mouseevent, artist, **kwargs)
This method will be called by artists who are picked and will
fire off PickEvent callbacks registered listeners
print_bmp = print_raw(self, *args, **kwargs)
print_emf(self, *args, **kwargs)
print_eps(self, *args, **kwargs)
print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w', orientation='portrait', format=None, **kwargs)
Render the figure to hardcopy. Set the figure patch face and edge
colors.  This is useful because some of the GUIs have a gray figure
face color background and you'll probably want to override this on
hardcopy.
 
filename    - can also be a file object on image backends
orientation - only currently applies to PostScript printing.
dpi - the dots per inch to save the figure in; if None, use savefig.dpi
facecolor - the facecolor of the figure
edgecolor - the edgecolor of the figure
orientation - 'landscape' | 'portrait' (not supported on all backends)
format - when set, forcibly set the file format to save to
print_raw(self, *args, **kwargs)
print_rgb = print_raw(self, *args, **kwargs)
resize(self, w, h)
set the canvas size in pixels
resize_event(self)
scroll_event(self, x, y, button, guiEvent=None)
Backend derived classes should call this function on any
scroll wheel event.  x,y are the canvas coords: 0,0 is lower,
left.  button and key are as defined in MouseEvent
set_window_title(self, title)
Set the title text of the window containing the figure.  Note that
this has no effect if there is no window (eg, a PS backend).
switch_backends(self, FigureCanvasClass)
instantiate an instance of FigureCanvasClass
 
This is used for backend switching, eg, to instantiate a
FigureCanvasPS from a FigureCanvasGTK.  Note, deep copying is
not done, so any changes to one of the instances (eg, setting
figure size or line props), will be reflected in the other

Data and other attributes inherited from matplotlib.backend_bases.FigureCanvasBase:
events = ('resize_event', 'draw_event', 'key_press_event', 'key_release_event', 'button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event', 'pick_event')
filetypes = {'emf': 'Enhanced Metafile', 'eps': 'Encapsulated Postscript', 'pdf': 'Portable Document Format', 'png': 'Portable Network Graphics', 'ps': 'Postscript', 'raw': 'Raw RGBA bitmap', 'rgba': 'Raw RGBA bitmap', 'svg': 'Scalable Vector Graphics', 'svgz': 'Scalable Vector Graphics'}

 
class GraphicsContextCairo(matplotlib.backend_bases.GraphicsContextBase)
     Methods defined here:
__init__(self, renderer)
set_alpha(self, alpha)
set_capstyle(self, cs)
set_clip_path(self, path)
set_clip_rectangle(self, rectangle)
set_dashes(self, offset, dashes)
set_foreground(self, fg, isRGB=None)
set_graylevel(self, frac)
set_joinstyle(self, js)
set_linewidth(self, w)

Methods inherited from matplotlib.backend_bases.GraphicsContextBase:
copy_properties(self, gc)
Copy properties from gc to self
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_antialiased(self)
Return true if the object should try to do antialiased rendering
get_capstyle(self)
Return the capstyle as a string in ('butt', 'round', 'projecting')
get_clip_path(self)
Return the clip path in the form (path, transform), where path
is a path.Path instance, and transform as an affine transform
to apply to the path before clipping.
get_clip_rectangle(self)
Return the clip rectangle as a Bbox instance
get_dashes(self)
Return the dash information as an offset dashlist tuple The
dash list is a even size list that gives the ink on, ink off
in pixels.  See p107 of to postscript BLUEBOOK for more info
 
Default value is None
get_hatch(self)
Gets the current hatch style
get_joinstyle(self)
Return the line join style as one of ('miter', 'round', 'bevel')
get_linestyle(self, style)
Return the linestyle: one of ('solid', 'dashed', 'dashdot',
'dotted').
get_linewidth(self)
Return the line width in points as a scalar
get_rgb(self)
returns a tuple of three floats from 0-1.  color can be a
matlab format string, a html hex color string, or a rgb tuple
set_antialiased(self, b)
True if object should be drawn with antialiased rendering
set_hatch(self, hatch)
Sets the hatch style for filling
set_linestyle(self, style)
Set the linestyle to be one of ('solid', 'dashed', 'dashdot',
'dotted').

Data and other attributes inherited from matplotlib.backend_bases.GraphicsContextBase:
dashd = {'dashdot': (0, (3.0, 5.0, 1.0, 5.0)), 'dashed': (0, (6.0, 6.0)), 'dotted': (0, (1.0, 3.0)), 'solid': (None, None)}

 
class RendererCairo(matplotlib.backend_bases.RendererBase)
     Methods defined here:
__init__(self, dpi)
draw_image(self, x, y, im, bbox, clippath=None, clippath_trans=None)
draw_path(self, gc, path, transform, rgbFace=None)
draw_text(self, gc, x, y, s, prop, angle, ismath=False)
flipy(self)
get_canvas_width_height(self)
get_text_width_height_descent(self, s, prop, ismath)
new_gc(self)
points_to_pixels(self, points)
set_ctx_from_surface(self, surface)
set_width_height(self, width, height)

Static methods defined here:
convert_path(ctx, tpath)
#@staticmethod

Data and other attributes defined here:
fontangles = {'italic': 1, 'normal': 0, 'oblique': 2}
fontweights = {100: 0, 200: 0, 300: 0, 400: 0, 500: 0, 600: 1, 700: 1, 800: 1, 900: 1, 'black': 1, ...}

Methods inherited from matplotlib.backend_bases.RendererBase:
close_group(self, s)
close a grouping element with label s
Is only currently used by backend_svg
draw_markers(self, gc, marker_path, marker_trans, path, trans, rgbFace=None)
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.
 
marker_trans is an affine transform applied to the marker.
trans is an affine transform applied to the path.
 
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.
draw_path_collection(self, master_transform, cliprect, clippath, clippath_trans, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds)
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.
 
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_quad_mesh(self, master_transform, cliprect, clippath, clippath_trans, meshWidth, meshHeight, coordinates, offsets, offsetTrans, facecolors, antialiased, showedges)
This provides a fallback implementation of draw_quad_mesh that
generates paths and then calls draw_path_collection.
draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!')
get_image_magnification(self)
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_texmanager(self)
open_group(self, s)
open a grouping element with label s
Is only currently used by backend_svg
option_image_nocomposite(self)
overwrite this method for renderers that do not necessarily
want to rescale and composite raster images. (like SVG)
start_rasterizing(self)
stop_rasterizing(self)
strip_math(self, s)

 
Functions
       
new_figure_manager(num, *args, **kwargs)
Create a new figure manager instance

 
Data
        BYTE_FORMAT = 0
backend_version = '1.4.12'
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
rcParams = {'figure.subplot.right': 0.90000000000000002, 'm...persize': 'letter', 'svg.embed_char_paths': True}
@footer@