136 lines (120 with data), 11.7 kB
@header@
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="matplotlib.html"><font color="#ffffff">matplotlib</font></a>.rcsetup</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/rcsetup.py">/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/rcsetup.py</a></font></td></tr></table>
<p><tt>The rcsetup module contains the default values and the validation code for<br>
customization using matplotlib's rc settings.<br>
<br>
Each rc setting is assigned a default value and a function used to validate any<br>
attempted changes to that setting. The default values and validation functions<br>
are defined in the rcsetup module, and are used to construct the rcParams global<br>
object which stores the settings and is referenced throughout matplotlib.<br>
<br>
These default values should be consistent with the default matplotlibrc file<br>
that actually reflects the values given here. Any additions or deletions to the<br>
parameter set listed here should also be visited to the<br>
:file:`matplotlibrc.template` in matplotlib's root source directory.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
</td><td width="25%" valign=top><a href="warnings.html">warnings</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="matplotlib.rcsetup.html#ValidateInStrings">ValidateInStrings</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.rcsetup.html#ValidateInterval">ValidateInterval</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.rcsetup.html#validate_nseq_float">validate_nseq_float</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.rcsetup.html#validate_nseq_int">validate_nseq_int</a>
</font></dt></dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="ValidateInStrings">class <strong>ValidateInStrings</strong></a></font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="ValidateInStrings-__call__"><strong>__call__</strong></a>(self, s)</dt></dl>
<dl><dt><a name="ValidateInStrings-__init__"><strong>__init__</strong></a>(self, key, valid, ignorecase<font color="#909090">=False</font>)</dt><dd><tt>valid is a list of legal strings</tt></dd></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="ValidateInterval">class <strong>ValidateInterval</strong></a></font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Value must be in interval<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="ValidateInterval-__call__"><strong>__call__</strong></a>(self, s)</dt></dl>
<dl><dt><a name="ValidateInterval-__init__"><strong>__init__</strong></a>(self, vmin, vmax, closedmin<font color="#909090">=True</font>, closedmax<font color="#909090">=True</font>)</dt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="validate_nseq_float">class <strong>validate_nseq_float</strong></a></font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="validate_nseq_float-__call__"><strong>__call__</strong></a>(self, s)</dt><dd><tt>return a seq of n floats or raise</tt></dd></dl>
<dl><dt><a name="validate_nseq_float-__init__"><strong>__init__</strong></a>(self, n)</dt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="validate_nseq_int">class <strong>validate_nseq_int</strong></a></font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="validate_nseq_int-__call__"><strong>__call__</strong></a>(self, s)</dt><dd><tt>return a seq of n ints or raise</tt></dd></dl>
<dl><dt><a name="validate_nseq_int-__init__"><strong>__init__</strong></a>(self, n)</dt></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-validate_aspect"><strong>validate_aspect</strong></a>(s)</dt></dl>
<dl><dt><a name="-validate_autolayout"><strong>validate_autolayout</strong></a>(v)</dt></dl>
<dl><dt><a name="-validate_bool"><strong>validate_bool</strong></a>(b)</dt><dd><tt>Convert b to a boolean or raise</tt></dd></dl>
<dl><dt><a name="-validate_bool_maybe_none"><strong>validate_bool_maybe_none</strong></a>(b)</dt><dd><tt>Convert b to a boolean or raise</tt></dd></dl>
<dl><dt><a name="-validate_color"><strong>validate_color</strong></a>(s)</dt><dd><tt>return a valid color arg</tt></dd></dl>
<dl><dt><a name="-validate_float"><strong>validate_float</strong></a>(s)</dt><dd><tt>convert s to float or raise</tt></dd></dl>
<dl><dt><a name="-validate_font_properties"><strong>validate_font_properties</strong></a>(s)</dt></dl>
<dl><dt><a name="-validate_fontsize"><strong>validate_fontsize</strong></a>(s)</dt></dl>
<dl><dt><a name="-validate_fonttype"><strong>validate_fonttype</strong></a>(s)</dt><dd><tt>confirm that this is a Postscript of PDF font type that we know how to convert to</tt></dd></dl>
<dl><dt><a name="-validate_int"><strong>validate_int</strong></a>(s)</dt><dd><tt>convert s to int or raise</tt></dd></dl>
<dl><dt><a name="-validate_negative_linestyle_legacy"><strong>validate_negative_linestyle_legacy</strong></a>(s)</dt></dl>
<dl><dt><a name="-validate_path_exists"><strong>validate_path_exists</strong></a>(s)</dt><dd><tt>If s is a path, return s, else False</tt></dd></dl>
<dl><dt><a name="-validate_ps_distiller"><strong>validate_ps_distiller</strong></a>(s)</dt></dl>
<dl><dt><a name="-validate_stringlist"><strong>validate_stringlist</strong></a>(s)</dt><dd><tt>return a list</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>all_backends</strong> = ['GTK', 'GTKAgg', 'GTKCairo', 'FltkAgg', 'QtAgg', 'Qt4Agg', 'TkAgg', 'WX', 'WXAgg', 'CocoaAgg', 'agg', 'cairo', 'emf', 'gdk', 'pdf', 'ps', 'svg', 'template']<br>
<strong>defaultParams</strong> = {'axes.axisbelow': [False, <function validate_bool at 0x1c00848>], 'axes.edgecolor': ['k', <function validate_color at 0x1c108c0>], 'axes.facecolor': ['w', <function validate_color at 0x1c108c0>], 'axes.formatter.limits': [[-7, 7], <matplotlib.rcsetup.validate_nseq_int instance at 0x7f2c5a5272d8>], 'axes.grid': [False, <function validate_bool at 0x1c00848>], 'axes.hold': [True, <function validate_bool at 0x1c00848>], 'axes.labelcolor': ['k', <function validate_color at 0x1c108c0>], 'axes.labelsize': ['medium', <function validate_fontsize at 0x7f2c5a524488>], 'axes.linewidth': [1.0, <function validate_float at 0x1c0c320>], 'axes.titlesize': ['large', <function validate_fontsize at 0x7f2c5a524488>], ...}<br>
<strong>interactive_bk</strong> = ['GTK', 'GTKAgg', 'GTKCairo', 'FltkAgg', 'QtAgg', 'Qt4Agg', 'TkAgg', 'WX', 'WXAgg', 'CocoaAgg']<br>
<strong>non_interactive_bk</strong> = ['agg', 'cairo', 'emf', 'gdk', 'pdf', 'ps', 'svg', 'template']<br>
<strong>validate_backend</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x1d437e8><br>
<strong>validate_cairo_format</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523cb0><br>
<strong>validate_capstyle</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523d88><br>
<strong>validate_fontset</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523c20><br>
<strong>validate_joinstyle</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523d40><br>
<strong>validate_legend_loc</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523e18><br>
<strong>validate_negative_linestyle</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523dd0><br>
<strong>validate_numerix</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523bd8><br>
<strong>validate_orientation</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523b00><br>
<strong>validate_ps_papersize</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523cf8><br>
<strong>validate_toolbar</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523b48><br>
<strong>validate_verbose</strong> = <matplotlib.rcsetup.ValidateInStrings instance at 0x7f2c5a523c68></td></tr></table>
@footer@