| | |
- matplotlib.backend_bases.FigureCanvasBase
-
- FigureCanvasAgg
- matplotlib.backend_bases.RendererBase
-
- RendererAgg
class FigureCanvasAgg(matplotlib.backend_bases.FigureCanvasBase) |
| |
The canvas the figure renders into. Calls the draw and print fig
methods, creates the renderers, etc...
Public attribute
figure - A Figure instance
|
| |
Methods defined here:
- buffer_rgba(self, x, y)
- copy_from_bbox(self, bbox)
- draw(self)
- Draw the figure using the renderer
- get_default_filetype(self)
- get_renderer(self)
- print_png(self, filename_or_obj, *args, **kwargs)
- print_raw(self, filename_or_obj, *args, **kwargs)
- print_rgba = print_raw(self, filename_or_obj, *args, **kwargs)
- restore_region(self, region)
- tostring_argb(self)
- tostring_rgb(self)
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_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_pdf(self, *args, **kwargs)
- print_ps(self, *args, **kwargs)
- print_rgb = print_raw(self, *args, **kwargs)
- print_svg(self, *args, **kwargs)
- print_svgz(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 RendererAgg(matplotlib.backend_bases.RendererBase) |
| |
The renderer handles all the drawing primitives using a graphics
context instance that controls the colors/styles
|
| |
Methods defined here:
- __init__(self, width, height, dpi)
- buffer_rgba(self, x, y)
- clear(self)
- draw_mathtext(self, gc, x, y, s, prop, angle)
- Draw the math text using matplotlib.mathtext
- draw_tex(self, gc, x, y, s, prop, angle)
- draw_text(self, gc, x, y, s, prop, angle, ismath)
- Render the text
- get_canvas_width_height(self)
- return the canvas width and height in display coords
- get_text_width_height_descent(self, s, prop, ismath)
- get the width and height in display coords of the string s
with FontPropertry prop
# passing rgb is a little hack to make cacheing in the
# texmanager more efficient. It is not meant to be used
# outside the backend
- points_to_pixels(self, points)
- convert point measures to pixes using dpi and the pixels per
inch of the display
- tostring_argb(self)
- tostring_rgb(self)
Data and other attributes defined here:
- debug = 1
- texd = {}
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_image(self, x, y, im, bbox, clippath=None, clippath_trans=None)
- Draw the Image instance into the current axes; x is the
distance in pixels from the left hand side of the canvas. y is
the distance from the origin. That is, if origin is upper, y
is the distance from top. If origin is lower, y is the
distance from bottom
bbox is a matplotlib.transforms.BBox instance for clipping, or
None
- 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(self, gc, path, transform, rgbFace=None)
- Draws a Path instance using the given affine transform.
- 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.
- flipy(self)
- return true if y small numbers are top for renderer
Is used for drawing text (text.py) and images (image.py) only
- 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)
- new_gc(self)
- Return an instance of a GraphicsContextBase
- 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)
| |