@header@
 
 
matplotlib.axis
index
/usr/local/lib/python2.3/site-packages/matplotlib/axis.py

Classes for the ticks and x and y axis

 
Modules
       
copy
math
re
sys

 
Classes
       
matplotlib.artist.Artist
Axis
XAxis
YAxis
Tick
XTick
YTick

 
class Axis(matplotlib.artist.Artist)
    Public attributes
  transData - transform data coords to display coords
  transAxis - transform axis coords to display coords
 
  Methods defined here:
__init__(self, axes)
Init the axis with the parent Axes instance
draw(self, renderer, *args, **kwargs)
Draw the axis lines, grid lines, tick lines and labels
get_data_interval(self)
return the Interval instance for this axis data limits
get_gridlines(self)
Return the grid lines as a list of Line2D instance
get_label(self)
Return the axis label as an Text instance
get_major_locator(self)
Get the locator of the major ticker
get_major_ticks(self)
get the tick instances; grow as necessary
get_minor_locator(self)
Get the locator of the minor ticker
get_minor_ticks(self)
get the minor tick instances; grow as necessary
get_ticklabels(self)
Return a list of Text instances for ticklabels
get_ticklines(self)
Return the ticklines lines as a list of Line2D instance
get_ticklocs(self)
Get the tick locations in data coordinates as a Numeric array
get_view_interval(self)
return the Interval instance for this axis view limits
grid(self, b, which='major')
Set the axis grid on or off; b is a boolean use which =
'major' | 'minor' to set the grid for major or minor ticks
pan(self, numsteps)
Pan numticks (can be positive or negative)
set_major_formatter(self, formatter)
Set the formatter of the major ticker
set_major_locator(self, locator)
Set the locator of the major ticker
set_minor_formatter(self, formatter)
Set the formatter of the minor ticker
set_minor_locator(self, locator)
Set the locator of the minor ticker
set_ticklabels(self, ticklabels, *args, **kwargs)
Set the text values of the tick labels.  ticklabels is a
sequence of strings.  Return a list of Text instances
set_ticks(self, ticks)
Set the locations of the tick marks from sequence ticks
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out

Data and other attributes defined here:
LABELPAD = 5

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
class Tick(matplotlib.artist.Artist)
    Abstract base class for the axis ticks, grid lines and labels
 
Publicly accessible attributes
 
  tick1line  : a Line2D instance
  tick2line  : a Line2D instance
  gridline   : a Line2D instance
  label1      : an Text instance
  label2      : an Text instance
  gridOn     : a boolean which determines whether to draw the tickline
  tick1On    : a boolean which determines whether to draw the 1st tickline
               (left for xtick and bottom for yticks)
  tick2On    : a boolean which determines whether to draw the 2nd tickline
               (left for xtick and bottom for yticks)
  label1On    : a boolean which determines whether to draw tick label
  label2On    : a boolean which determines whether to draw tick label
 
  Methods defined here:
__init__(self, axes, loc, label, size=None, gridOn=None, tick1On=True, tick2On=True, label1On=True, label2On=False, major=True)
bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in relative, axes coords
draw(self, renderer)
get_loc(self)
Return the tick location (data coords) as a scalar
get_pad(self, val)
Get the value of the tick label pad in points
get_view_interval(self)
return the view Interval instance for the axis tjis tick is ticking
set_label(self, s)
Set the text of ticklabel in with string s
set_label1(self, s)
Set the text of ticklabel in with string s
set_label2(self, s)
Set the text of ticklabel2 in with string s
set_pad(self, val)
Set the tick label pad in points
set_xy(self, loc)
Set the location of tick in data coords with scalar loc

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
class XAxis(Axis)
    
Method resolution order:
XAxis
Axis
matplotlib.artist.Artist

Methods defined here:
get_data_interval(self)
return the Interval instance for this axis data limits
get_view_interval(self)
return the Interval instance for this axis view limits
tick_bottom(self)
use ticks only on bottom
tick_top(self)
use ticks only on top

Methods inherited from Axis:
__init__(self, axes)
Init the axis with the parent Axes instance
draw(self, renderer, *args, **kwargs)
Draw the axis lines, grid lines, tick lines and labels
get_gridlines(self)
Return the grid lines as a list of Line2D instance
get_label(self)
Return the axis label as an Text instance
get_major_locator(self)
Get the locator of the major ticker
get_major_ticks(self)
get the tick instances; grow as necessary
get_minor_locator(self)
Get the locator of the minor ticker
get_minor_ticks(self)
get the minor tick instances; grow as necessary
get_ticklabels(self)
Return a list of Text instances for ticklabels
get_ticklines(self)
Return the ticklines lines as a list of Line2D instance
get_ticklocs(self)
Get the tick locations in data coordinates as a Numeric array
grid(self, b, which='major')
Set the axis grid on or off; b is a boolean use which =
'major' | 'minor' to set the grid for major or minor ticks
pan(self, numsteps)
Pan numticks (can be positive or negative)
set_major_formatter(self, formatter)
Set the formatter of the major ticker
set_major_locator(self, locator)
Set the locator of the major ticker
set_minor_formatter(self, formatter)
Set the formatter of the minor ticker
set_minor_locator(self, locator)
Set the locator of the minor ticker
set_ticklabels(self, ticklabels, *args, **kwargs)
Set the text values of the tick labels.  ticklabels is a
sequence of strings.  Return a list of Text instances
set_ticks(self, ticks)
Set the locations of the tick marks from sequence ticks
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out

Data and other attributes inherited from Axis:
LABELPAD = 5

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
class XTick(Tick)
    Contains all the Artists needed to make an x tick - the tick line,
the label text and the grid line
 
 
Method resolution order:
XTick
Tick
matplotlib.artist.Artist

Methods defined here:
get_data_interval(self)
return the Interval instance for this axis data limits
get_view_interval(self)
return the Interval instance for this axis view limits
update_position(self, loc)
Set the location of tick in data coords with scalar loc

Methods inherited from Tick:
__init__(self, axes, loc, label, size=None, gridOn=None, tick1On=True, tick2On=True, label1On=True, label2On=False, major=True)
bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in relative, axes coords
draw(self, renderer)
get_loc(self)
Return the tick location (data coords) as a scalar
get_pad(self, val)
Get the value of the tick label pad in points
set_label(self, s)
Set the text of ticklabel in with string s
set_label1(self, s)
Set the text of ticklabel in with string s
set_label2(self, s)
Set the text of ticklabel2 in with string s
set_pad(self, val)
Set the tick label pad in points
set_xy(self, loc)
Set the location of tick in data coords with scalar loc

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
class YAxis(Axis)
    
Method resolution order:
YAxis
Axis
matplotlib.artist.Artist

Methods defined here:
get_data_interval(self)
return the Interval instance for this axis data limits
get_view_interval(self)
return the Interval instance for this axis view limits
tick_left(self)
use ticks only on left
tick_right(self)
use ticks only on right

Methods inherited from Axis:
__init__(self, axes)
Init the axis with the parent Axes instance
draw(self, renderer, *args, **kwargs)
Draw the axis lines, grid lines, tick lines and labels
get_gridlines(self)
Return the grid lines as a list of Line2D instance
get_label(self)
Return the axis label as an Text instance
get_major_locator(self)
Get the locator of the major ticker
get_major_ticks(self)
get the tick instances; grow as necessary
get_minor_locator(self)
Get the locator of the minor ticker
get_minor_ticks(self)
get the minor tick instances; grow as necessary
get_ticklabels(self)
Return a list of Text instances for ticklabels
get_ticklines(self)
Return the ticklines lines as a list of Line2D instance
get_ticklocs(self)
Get the tick locations in data coordinates as a Numeric array
grid(self, b, which='major')
Set the axis grid on or off; b is a boolean use which =
'major' | 'minor' to set the grid for major or minor ticks
pan(self, numsteps)
Pan numticks (can be positive or negative)
set_major_formatter(self, formatter)
Set the formatter of the major ticker
set_major_locator(self, locator)
Set the locator of the major ticker
set_minor_formatter(self, formatter)
Set the formatter of the minor ticker
set_minor_locator(self, locator)
Set the locator of the minor ticker
set_ticklabels(self, ticklabels, *args, **kwargs)
Set the text values of the tick labels.  ticklabels is a
sequence of strings.  Return a list of Text instances
set_ticks(self, ticks)
Set the locations of the tick marks from sequence ticks
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out

Data and other attributes inherited from Axis:
LABELPAD = 5

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
class YTick(Tick)
    Contains all the Artists needed to make a Y tick - the tick line,
the label text and the grid line
 
 
Method resolution order:
YTick
Tick
matplotlib.artist.Artist

Methods defined here:
get_data_interval(self)
return the Interval instance for this axis data limits
get_view_interval(self)
return the Interval instance for this axis view limits
update_position(self, loc)
Set the location of tick in data coords with scalar loc

Methods inherited from Tick:
__init__(self, axes, loc, label, size=None, gridOn=None, tick1On=True, tick2On=True, label1On=True, label2On=False, major=True)
bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in relative, axes coords
draw(self, renderer)
get_loc(self)
Return the tick location (data coords) as a scalar
get_pad(self, val)
Get the value of the tick label pad in points
set_label(self, s)
Set the text of ticklabel in with string s
set_label1(self, s)
Set the text of ticklabel in with string s
set_label2(self, s)
Set the text of ticklabel2 in with string s
set_pad(self, val)
Set the tick label pad in points
set_xy(self, loc)
Set the location of tick in data coords with scalar loc

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
Functions
       
Value(...)
Value(x)
arange(...)
arange(start, stop=None, step=1, typecode=None)
 
 Just like range() except it returns an array whose type can be
specified by the keyword argument typecode.
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.
take(...)
take(a, indices, axis=0).  Selects the elements in indices from array a along the given axis.
zeros(...)
zeros((d1,...,dn),typecode='l',savespace=0) will return a new array of shape (d1,...,dn) and type typecode with all it's entries initialized to zero.  If savespace is nonzero the array will be a spacesaver array.

 
Data
        False = False
Float = 'd'
TICKDOWN = 3
TICKLEFT = 0
TICKRIGHT = 1
TICKUP = 2
True = True
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
log10 = <ufunc 'log10'>
logical_and = <ufunc 'logical_and'>
rcParams = {'axes.edgecolor': 'k', 'axes.facecolor': 'w', 'axes.grid': False, 'axes.hold': True, 'axes.labelcolor': 'k', 'axes.labelsize': 12.0, 'axes.linewidth': 1.0, 'axes.titlesize': 14.0, 'backend': 'GTKAgg', 'datapath': '/usr/local/share/matplotlib', ...}
@footer@