| | |
- matplotlib.backend_bases.FigureCanvasBase
-
- FigureCanvasTemplate
- matplotlib.backend_bases.FigureManagerBase
-
- FigureManagerTemplate
- FigureManagerTemplate
- matplotlib.backend_bases.GraphicsContextBase
-
- GraphicsContextTemplate
- matplotlib.backend_bases.RendererBase
-
- RendererTemplate
class FigureCanvasTemplate(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:
- draw(self)
- Draw the figure using the renderer
- 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
- realize(self, *args)
- This method will be called when the system is ready to draw,
eg when a GUI window is realized
Methods inherited from matplotlib.backend_bases.FigureCanvasBase:
- __init__(self, figure)
- 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 GraphicsContextTemplate(matplotlib.backend_bases.GraphicsContextBase) |
| |
The graphics context provides the color, line styles, etc... See
the gtk and postscript backends for examples of mapping the
graphics context attributes (cap styles, join styles, line widths,
colors) to a particular backend. In GTK this is done by wrapping
a gtk.gdk.GC object and forwarding the appropriate calls to it
using a dictionary mapping styles to gdk constants. In
Postscript, all the work is done by the renderer, mapping line
styles to postscript calls.
The base GraphicsContext stores colors as a RGB tuple on the unit
interval, eg, (0.5, 0.0, 1.0). You will probably need to map this
to colors appropriate for your backend. Eg, see the ColorManager
class for the GTK backend. If it's more appropriate to do the
mapping at the renderer level (as in the postscript backend), you
don't need to override any of the GC methods. If it's more
approritate to wrap an instance (as in the GTK backend) and do the
mapping here, you'll need to override several of the setter
methods.
|
| |
Methods inherited from matplotlib.backend_bases.GraphicsContextBase:
- __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 RendererTemplate(matplotlib.backend_bases.RendererBase) |
| |
The renderer handles all the drawing primitives using a graphics
context instance that controls the colors/styles
|
| |
Methods defined here:
- compute_text_offsets(self, text)
- Return the (x,y) offsets to adjust for the alignment
specifications. This method is not required by the API, but
is a useful to compute the alignment offsets
- draw_arc(self, gcEdge, rgbFace, 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 rgbFace is not None, fill the rectangle with it. gcEdge
is a GraphicsContext instance
- draw_line(self, gc, x1, y1, x2, y2)
- Draw a single line from x1,y1 to x2,y2
- 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_polygon(self, gcEdge, 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 rectangle with it. gcEdge
is a GraphicsContext instance
- draw_rectangle(self, gcEdge, rgbFace, x, y, width, height)
- Draw a rectangle at lower left x,y with width and height.
If rgbFace is not None, fill the rectangle with it. gcEdge
is a GraphicsContext instance
- draw_text(self, gc, x, y, text)
- Render the matplotlib.text.Text instance at x, y in window
coords using GraphicsContext gc
- get_text_extent(self, text)
- Return the ink extent of the text as Bound2D instance
- new_gc(self)
- Return an instance of a GraphicsContextTemplate
- points_to_pixels(self, points)
- convert points to display units. Many imaging systems assume
some value for pixels per inch. Eg, suppose yours is 96 and
dpi = 300. Then points to pixels is
| |