Package matplotlib :: Package backends :: Module backend_agg :: Class FigureCanvasAgg
[show private | hide private]
[frames | no frames]

Class FigureCanvasAgg

FigureCanvasBase --+
                   |
                  FigureCanvasAgg

Known Subclasses:
FigureCanvasWxAgg

The canvas the figure renders into.  Calls the draw and print fig
methods, creates the renderers, etc...

Public attribute

  figure - A Figure instance

Method Summary
  buffer_rgba(self)
  copy_from_bbox(self, bbox)
  draw(self)
Draw the figure using the renderer
  get_renderer(self)
  print_figure(self, filename, dpi, facecolor, edgecolor, orientation)
Render the figure to hardcopy.
  restore_region(self, region)
  tostring_argb(self)
  tostring_rgb(self)
    Inherited from FigureCanvasBase
  __init__(self, figure)
  blit(self, bbox)
blit the canvas in bbox (default entire canvas)
  button_press_event(self, x, y, button, guiEvent)
Backend derived classes should call this function on any mouse button press.
  button_release_event(self, x, y, button, guiEvent)
Backend derived classes should call this function on any mouse button release.
  draw_cursor(self, event)
Draw a cursor in the event.axes if inaxes is not None.
  draw_event(self, renderer)
  draw_idle(self, *args, **kwargs)
draw only if idle; defaults to draw but backends can overrride
  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)
  key_release_event(self, key, guiEvent)
  motion_notify_event(self, x, y, guiEvent)
Backend derived classes should call this function on any motion-notify-event.
  mpl_connect(self, s, func)
Connect event with string s to func.
  mpl_disconnect(self, cid)
Connect s to func.
  switch_backends(self, FigureCanvasClass)
instantiate an instance of FigureCanvasClass

Class Variable Summary
    Inherited from FigureCanvasBase
tuple events = ('key_press_event', 'key_release_event', 'butto...

Method Details

draw(self)

Draw the figure using the renderer
Overrides:
matplotlib.backend_bases.FigureCanvasBase.draw

print_figure(self, filename, dpi=150, facecolor='w', edgecolor='w', orientation='portrait')

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

If the extension matches PNG, write a PNG file

If the extension matches BMP or RAW, write an RGBA bitmap file

If filename is a fileobject, write png to file object (thus you can, for example, write the png to stdout
Overrides:
matplotlib.backend_bases.FigureCanvasBase.print_figure

Generated by Epydoc 2.1 on Mon Aug 28 13:47:50 2006 http://epydoc.sf.net