| | |
- FigureCanvasBase
- FigureManagerBase
- GraphicsContextBase
- RendererBase
class FigureCanvasBase |
| |
The canvas the figure renders into.
Public attribute
figure - A Figure instance
|
| |
Methods defined here:
- __init__(self, figure)
- draw(self)
- Render the figure
- print_figure(self, filename, dpi=300, facecolor='w', edgecolor='w')
- 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
- 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
|
class FigureManagerBase |
| |
Helper class for matlab mode, wraps everything up into a neat bundle
Public attibutes
canvas - A FigureCanvas instance
num - The figure number
|
| |
Methods defined here:
- __init__(self, canvas, num)
- add_axes(self, rect, **kwargs)
- Add an axes to the current figure
- add_subplot(self, *args, **kwargs)
- Add a subplot to the current figure
- clf(self)
- clear the figure
- destroy(self)
- get_current_axis(self)
- Return the current axes
- set_current_axes(self, a)
- Set the current axes to be a
|
class GraphicsContextBase |
| | |
Methods defined here:
- __init__(self)
- 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 shuold try to do antialiased rendering
- get_capstyle(self)
- Return the capstyle as a string in ('butt', 'round', 'projecting')
- get_clip_rectangle(self)
- Return the clip rectangle as (left, bottom, width, height)
- 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_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_alpha(self, alpha)
- Set the alpha value used for blending - not supported on
all backends
- set_antialiased(self, b)
- True if object should be drawn with antialiased rendering
- set_capstyle(self, cs)
- Set the capstyle as a string in ('butt', 'round', 'projecting')
- set_clip_rectangle(self, rectangle)
- Set the clip rectangle with sequence (left, bottom, width, height)
- set_dashes(self, dash_offset, dash_list)
- Set the dash style for the gc. dash offset is the offset
(usually 0). Dash list specifies the on-off sequence as
points
- set_foreground(self, fg, isRGB=None)
- Set the foreground color. fg can be a matlab format string, a
html hex color string, an rgb unit tuple, or a float between 0
and 1. In the latter case, grayscale is used.
The GraphicsContext converts colors to rgb internally. If you
know the color is rgb already, you can set isRGB to True to
avoid the performace hit of the conversion
- set_graylevel(self, frac)
- Set the foreground color to be a gray level with frac frac
- set_joinstyle(self, js)
- Set the join style to be one of ('miter', 'round', 'bevel')
- set_linestyle(self, style)
- Set the linestyle to be one of ('solid', 'dashed', 'dashdot',
'dotted').
- set_linewidth(self, w)
- Set the linewidth in points
|
class RendererBase |
| | |
Methods defined here:
- close_group(self, s)
- close a grouping element with label s
- draw_arc(self, gcEdge, gcFace, x, y, width, height, angle1, angle2)
- Draw an arc centered at x,y with width and height and angles
from 0.0 to 360.0
If gcFace is not None, fill the rectangle with it. gcEdge
is a GraphicsContext instance
- draw_image(self, x, y, im, origin)
- Draw the Image instance into the current axes.
origin is 'upper' or 'lower'
- draw_line(self, gc, x1, y1, x2, y2)
- Draw a single line from x1,y1 to x2,y2
- draw_line_collection(self, segments, transform, clipbox, colors, linewidths, antialiaseds, offsets, transOffset)
- This is a function for optimized line drawing. If you need to
draw many line segments with similar properties, it is faster
to avoid the overhead of all the object creation etc. The
lack of total configurability is compensated for with
efficiency. Hence we don't use a GC and many of the line
props it supports. See matplotlib.collections for more
details
sements is a sequence of ( (x00, y00, x01, y01), (x10, y10,
y11, y11), ) tuples. Unlike other backend commands, these are
in non-transfomed coords. Here we let the backend do the
transformation for efficiency
transform is used to Transform the lines
clipbox is a xmin, ymin, width, height clip rect
colors is a tuple of RGBA tuples
linewidths is a tuple of linewidths
antialiseds is a tuple of ones or zeros indicating whether the
segment should be aa or not
offsets, if not None, is a list of x,y offsets to translate
the lines by after transoff is used to transform the offset
coords
This function is intended to be overridden by the backend
level in extension code for backends that want fast line
collection drawing. Here is is implemented using native
backend calls and may be slow
- draw_lines(self, gc, x, y)
- x and y are equal length arrays, draw lines connecting each
point in x, y
- draw_point(self, gc, x, y)
- Draw a single point at x,y
- draw_poly_collection(self, verts, transform, clipbox, facecolors, edgecolors, linewidths, antialiaseds, offsets, transOffset)
- Draw a polygon collection
verts are a sequence of polygon vectors, where each polygon
vector is a sequence of x,y tuples of vertices
facecolors and edgecolors are a sequence of RGBA tuples
linewidths are a sequence of linewidths
antialiaseds are a sequence of 0,1 integers whether to use aa
- draw_polygon(self, gc, rgbFace, points)
- Draw a polygon. points is a len vertices tuple, each element
giving the x,y coords a vertex
If rgbFace is not None, fill the poly with it. gc
is a GraphicsContext instance
- draw_rectangle(self, gcEdge, gcFace, x, y, width, height)
- Draw a rectangle with lower left at x,y with width and height.
If gcFace is not None, fill the rectangle with it. gcEdge
is a GraphicsContext instance
- draw_regpoly_collection(self, clipbox, offsets, transOffset, verts, sizes, facecolors, edgecolors, linewidths, antialiaseds)
- Draw a regular poly collection
offsets is a sequence is x,y tuples and transOffset maps this
to display coords
verts are the vertices of the regular polygon at the origin
sizes are the area of the circle that circumscribes the
polygon in points^2
facecolors and edgecolors are a sequence of RGBA tuples
linewidths are a sequence of linewidths
antialiaseds are a sequence of 0,1 integers whether to use aa
- draw_text(self, gc, x, y, s, prop, angle, ismath=False)
- Draw string s at x,y (display coords) with font properties
instance prop at angle in degrees
- flipy(self)
- return true if y small numbers are top for renderer
- get_canvas_width_height(self)
- return the canvas width and height in display coords
- get_text_extent(self, text)
- Get the text extent in window coords
- get_text_width_height(self, s, fontsize, ismath=False)
- get the width and height in display coords of the string s
with fontsize in points
- new_gc(self)
- Return an instance of a GraphicsContextBase
- open_group(self, s)
- open a grouping element with label s
- points_to_pixels(self, points)
- convert points to display units; unless your backend doesn't
have dpi, eg, postscript, you need to overrride this function
| |