<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Bio.Graphics.Distribution.DistributionPage</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Bio-module.html">Package Bio</a> ::
<a href="Bio.Graphics-module.html">Package Graphics</a> ::
<a href="Bio.Graphics.Distribution-module.html">Module Distribution</a> ::
Class DistributionPage
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Bio.Graphics.Distribution.DistributionPage-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DistributionPage</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">DistributionPage</strong>
</pre>
<hr />
<p>Display a grouping of distributions on a page.</p>
<p>This organizes Distributions, and will display them nicely on a single
page.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.Graphics.Distribution.DistributionPage-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">output_format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">pdf</code><code class="variable-quote">'</code></span>)</span><br />
x.__init__(...) initializes x; see help(type(x)) for signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.Graphics.Distribution.DistributionPage-class.html#draw" class="summary-sig-name">draw</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">output_file</span>,
<span class="summary-sig-arg">title</span>)</span><br />
Draw out the distribution information.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage.draw">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_draw_title"></a><span class="summary-sig-name">_draw_title</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">cur_drawing</span>,
<span class="summary-sig-arg">title</span>,
<span class="summary-sig-arg">width</span>,
<span class="summary-sig-arg">height</span>)</span><br />
Add the title of the figure to the drawing.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage._draw_title">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.Graphics.Distribution.DistributionPage-class.html#_draw_distributions" class="summary-sig-name" onclick="show_private();">_draw_distributions</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">cur_drawing</span>,
<span class="summary-sig-arg">start_x_pos</span>,
<span class="summary-sig-arg">x_pos_change</span>,
<span class="summary-sig-arg">start_y_pos</span>,
<span class="summary-sig-arg">y_pos_change</span>,
<span class="summary-sig-arg">num_y_drawings</span>)</span><br />
Draw all of the distributions on the page.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage._draw_distributions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.Graphics.Distribution.DistributionPage-class.html#_draw_legend" class="summary-sig-name" onclick="show_private();">_draw_legend</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">cur_drawing</span>,
<span class="summary-sig-arg">start_y</span>,
<span class="summary-sig-arg">width</span>)</span><br />
Add a legend to the figure.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage._draw_legend">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">output_format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">pdf</code><code class="variable-quote">'</code></span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage.__init__">source code</a></span>
</td>
</tr></table>
<p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
<dl class="fields">
<dt>Overrides:
object.__init__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="draw"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">draw</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">output_file</span>,
<span class="sig-arg">title</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage.draw">source code</a></span>
</td>
</tr></table>
<pre class="literalblock">
Draw out the distribution information.
Arguments:
o output_file - The name of the file to output the information to,
or a handle to write to.
o title - A title to display on the graphic.
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_draw_distributions"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_draw_distributions</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">cur_drawing</span>,
<span class="sig-arg">start_x_pos</span>,
<span class="sig-arg">x_pos_change</span>,
<span class="sig-arg">start_y_pos</span>,
<span class="sig-arg">y_pos_change</span>,
<span class="sig-arg">num_y_drawings</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage._draw_distributions">source code</a></span>
</td>
</tr></table>
<p>Draw all of the distributions on the page.</p>
<p>Arguments:</p>
<p>o cur_drawing - The drawing we are working with.</p>
<p>o start_x_pos - The x position on the page to start drawing at.</p>
<p>o x_pos_change - The change in x position between each figure.</p>
<p>o start_y_pos - The y position on the page to start drawing at.</p>
<p>o y_pos_change - The change in y position between each figure.</p>
<p>o num_y_drawings - The number of drawings we'll have in the y
(up/down) direction.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_draw_legend"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_draw_legend</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">cur_drawing</span>,
<span class="sig-arg">start_y</span>,
<span class="sig-arg">width</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.Distribution-pysrc.html#DistributionPage._draw_legend">source code</a></span>
</td>
</tr></table>
<p>Add a legend to the figure.</p>
<p>Subclasses can implement to provide a specialized legend.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Thu Aug 18 18:19:26 2011
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
