Shouldn't colorbar_doc name be hidden from users? It doesn't look like the
rest other function documentation in pyplot.py file.
In [10]: color
colorbar colorbar_doc colormaps colors
at rev 7405.
In [10]: colorbar_doc
Out[10]: "\n\nAdd a colorbar to a plot.\n\nFunction signatures for the
:mod:`~matplotlib.pyplot` interface; all\nbut the first are also method
signatures for the\n:meth:`~matplotlib.figure.Figure.colorbar` method::\n\n
colorbar(**kwargs)\n colorbar(mappable, **kwargs)\n colorbar(mappable,
cax=cax, **kwargs)\n colorbar(mappable, ax=ax, **kwargs)\n\narguments:\n\n
*mappable*\n the :class:`~matplotlib.image.Image`,\n
:class:`~matplotlib.contour.ContourSet`, etc. to\n which the colorbar
applies; this argument is mandatory for the\n
:meth:`~matplotlib.figure.Figure.colorbar` method but optional for the\n
:func:`~matplotlib.pyplot.colorbar` function, which sets the\n default to
the current image.\n\nkeyword arguments:\n\n *cax*\n None | axes object
into which the colorbar will be drawn\n *ax*\n None | parent axes object
from which space for a new\n colorbar axes will be stolen\n\n\nAdditional
keyword arguments are of two kinds:\n\n axes properties:\n\n\n
============= ====================================================\n
Property Description\n =============
====================================================\n *orientation*
vertical or horizontal\n *fraction* 0.15; fraction of original axes to
use for colorbar\n *pad* 0.05 if vertical, 0.15 if horizontal;
fraction\n of original axes between colorbar and new image
axes\n *shrink* 1.0; fraction by which to shrink the colorbar\n
*aspect* 20; ratio of long to short dimensions\n =============
====================================================\n\n\n colorbar
properties:\n\n\n ===========
====================================================\n Property
Description\n ===========
====================================================\n *extend* [
'neither' | 'both' | 'min' | 'max' ]\n If not 'neither',
make pointed end(s) for out-of-\n range values. These are
set for a given colormap\n using the colormap set_under and
set_over methods.\n *spacing* [ 'uniform' | 'proportional'
]\n Uniform spacing gives each discrete color the
same\n space; proportional makes the space proportional
to\n the data interval.\n *ticks* [ None | list of
ticks | Locator object ]\n If None, ticks are determined
automatically from the\n input.\n *format* [ None |
format string | Formatter object ]\n If None,
the\n :class:`~matplotlib.ticker.ScalarFormatter` is
used.\n If a format string is given, e.g. '%.3f', that
is\n used. An alternative\n
:class:`~matplotlib.ticker.Formatter` object may be\n given
instead.\n *drawedges* [ False | True ] If true, draw lines at
color\n boundaries.\n ===========
====================================================\n\n The following
will probably be useful only in the context of\n indexed colors (that is,
when the mappable has norm=NoNorm()),\n or other unusual
circumstances.\n\n ============
===================================================\n Property
Description\n ============
===================================================\n *boundaries* None
or a sequence\n *values* None or a sequence which must be of length
1 less\n than the sequence of *boundaries*. For each
region\n delimited by adjacent entries in *boundaries*,
the\n color mapped to the corresponding value in
values\n will be used.\n ============
===================================================\n\n\n\nIf *mappable* is
a :class:`~matplotlib.contours.ContourSet`, its *extend*\nkwarg is included
automatically.\n\nNote that the *shrink* kwarg provides a simple way to keep
a vertical\ncolorbar, for example, from being taller than the axes of the
mappable\nto which the colorbar is attached; but it is a manual method
requiring\nsome trial and error. If the colorbar is too tall (or a
horizontal\ncolorbar is too wide) use a smaller value of *shrink*.\n\nFor
more precise control, you can manually specify the positions of\nthe axes
objects in which the mappable and the colorbar are drawn. In\nthis case, do
not use any of the axes properties kwargs.\n\nreturns:\n
:class:`~matplotlib.colorbar.Colorbar` instance; see also its base
class,\n :class:`~matplotlib.colorbar.ColorbarBase`. Call the\n
:meth:`~matplotlib.colorbar.ColorbarBase.set_label` method\n to label the
colorbar.\n\n"
--
Gökhan
------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now. http://p.sf.net/sfu/bobj-july
_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matplotlib-devel
