@header@
 
 
matplotlib.backend_bases
index
/matplotlib/backend_bases.py

Abstract base classes definine the primitives that renderers and
graphics contexts must implement to serve as a matplotlib backend

 
Modules
       
matplotlib.axes
sys

 
Classes
       
matplotlib.artist.Artist
AxisTextBase
FigureBase
FigureManagerBase
GraphicsContextBase
RendererBase

 
class AxisTextBase(matplotlib.artist.Artist)
    Handle storing and drawing of text in window or data coordinates
 
Publicly accessible attributes
  dpi     : a DPI instance
  bbox    : the display bounding box Bound2D instance
  transx : the transform of the x data
  transy : the transform of the y data
 
  Methods defined here:
__del__(self)
Bye bye
__init__(self, dpi, bbox, x=0, y=0, text='', color='k', verticalalignment='bottom', horizontalalignment='left', fontname='Times', fontsize=10, fontweight='normal', fontangle='normal', rotation=None, transx=Transform: Bound1D: 0 1 to Bound1D: 0 1, transy=Transform: Bound1D: 0 1 to Bound1D: 0 1)
erase(self)
get_fontangle(self)
Get the font angle as string
get_fontname(self)
Return the font name as string
get_fontsize(self)
Return the font size as integer
get_fontweight(self)
Get the font weight as string
get_horizontalalignment(self)
Return the horizontal alignment as string
get_position(self)
Return x, y as tuple
get_text(self)
Get the text as string
get_verticalalignment(self)
Return the vertical alignment as string
set_backgroundcolor(self, color)
Set the background color of the text
set_color(self, color)
Set the foreground color of the text
set_fontangle(self, angle)
Set the font angle, one of 'normal', 'italic', 'oblique'
set_fontname(self, fontname)
Set the font name, eg, 'Sans', 'Courier', 'Helvetica'
set_fontsize(self, fontsize)
Set the font size, eg, 8, 10, 12, 14...
set_fontweight(self, weight)
Set the font weight, one of:
'normal', 'bold', 'heavy', 'light', 'ultrabold',  'ultralight'
set_horizontalalignment(self, align)
Set the horizontal alignment to one of
'center', 'right', or 'left'
set_position(self, xy)
set_rotation(self, s)
Currently only s='vertical', or s='horizontal' are supported
set_text(self, text)
Set the text
set_verticalalignment(self, align)
Set the vertical alignment to one of
'center', 'top', or 'bottom'
set_x(self, x)
set_y(self, y)
update_properties(self, d)
Update the font attributes with the dictionary in d
wash_brushes(self)
Flush all state vars and prepare for a clean redraw

Data and other attributes defined here:
fontangles = {'italic': None, 'normal': None, 'oblique': None}
fontweights = {'bold': None, 'heavy': None, 'light': None, 'normal': None, 'ultrabold': None, 'ultralight': None}

Methods inherited from matplotlib.artist.Artist:
draw(self, drawable=None, *args, **kwargs)
Derived classes drawing method
get_child_artists(self)
Return all artists contained in self
get_dpi(self)
Get the DPI of the display
get_window_extent(self)
Return the window extent of the Artist as a Bound2D instance
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
set_renderer(self, renderer)
Set the renderer
set_transform(self, transform)
Set the artist transform for self and all children

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class FigureBase
     Methods defined here:
__init__(self, figsize, dpi, facecolor=0.75, edgecolor='k')
paper size is a w,h tuple in inches
DPI is dots per inch
add_axis(self, a)
clear(self)
draw(self, drawable=None, *args, **kwargs)
Render the figure using Renderer instance drawable
get_axes(self)
realize(self, *args)
This method will be called when the system is ready to draw,
eg when a GUI window is realized
text(self, x, y, s, *args, **kwargs)
Add text to figure at location x,y (relative 0-1 coords) See
the help for Axis text for the meaning of the other arguments

 
class FigureManagerBase
     Methods defined here:
__init__(self, figure, num)
add_axes(self, rect, axisbg)
Add an axes to the current figure
add_subplot(self, *args, **kwargs)
Add a subplot to the current 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_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_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)
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.
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:
draw_arc(self, gcEdge, faceColor, 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 faceColor 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, faceColor, points)
Draw a polygon.  points is a len vertices tuple, each element
giving the x,y coords a vertex
 
If faceColor is not None, fill the rectangle with it.  gcEdge
is a GraphicsContext instance
draw_rectangle(self, gcEdge, faceColor, x, y, width, height)
Draw a rectangle with lower left at x,y with width and height.
 
If faceColor is not None, fill the rectangle with it.  gcEdge
is a GraphicsContext instance
new_gc(self)
Return an instance of a GraphicsContextBase

 
Functions
       
arg_to_rgb(arg)
returns a tuple of three floats from 0-1.  arg can be a
matlab format string, a html hex color string, an rgb tuple,
or a float between 0 and 1.  In the latter case, grayscale is
used
array(...)
array(sequence, typecode=None, copy=1, savespace=0) will return a new array formed from the given (potentially nested) sequence with type given by typecode.  If no typecode is given, then the type will be determined as the minimum type required to hold the objects in sequence.  If copy is zero and sequence is already an array, a reference will be returned.  If savespace is nonzero, the new array will maintain its precision in operations.
error_msg(msg, *args, **kwargs)
Alert an error condition with message
hex2color(s)
Convert hex string (like html uses, eg, #efefef) to a r,g,b tuple

 
Data
        False = False
True = True
colors = {'b': (0.0, 0.0, 1.0), 'c': (0.0, 0.75, 0.75), 'g': (0.0, 0.5, 0.0), 'k': (0.0, 0.0, 0.0), 'm': (0.75, 0, 0.75), 'r': (1.0, 0.0, 0.0), 'w': (1.0, 1.0, 1.0), 'y': (0.75, 0.75, 0)}
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
@footer@