<?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.GenomeDiagram._AbstractDrawer</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.GenomeDiagram-module.html">Package GenomeDiagram</a> ::
Module _AbstractDrawer
</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.GenomeDiagram._AbstractDrawer-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module _AbstractDrawer</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html">source code</a></span></p>
<pre class="literalblock">
AbstractDrawer module (considered to be a private module, the API may change!)
Provides:
o AbstractDrawer - Superclass for methods common to *Drawer objects
o page_sizes - Method that returns a ReportLab pagesize when passed
a valid ISO size
o draw_box - Method that returns a closed path object when passed
the proper co-ordinates. For HORIZONTAL boxes only.
o angle2trig - Method that returns a tuple of values that are the
vector for rotating a point through a passed angle,
about an origin
o intermediate_points - Method that returns a list of values intermediate
between the points in a passed dataset
For drawing capabilities, this module uses reportlab to draw and write
the diagram:
http://www.reportlab.com
For dealing with biological information, the package expects BioPython
objects:
http://www.biopython.org
</pre>
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></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">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
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">
<a href="Bio.Graphics.GenomeDiagram._AbstractDrawer.AbstractDrawer-class.html" class="summary-name">AbstractDrawer</a><br />
AbstractDrawer
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></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">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
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.GenomeDiagram._AbstractDrawer-module.html#page_sizes" class="summary-sig-name">page_sizes</a>(<span class="summary-sig-arg">size</span>)</span><br />
o size A string representing a standard page size</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#page_sizes">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.GenomeDiagram._AbstractDrawer-module.html#draw_box" class="summary-sig-name">draw_box</a>(<span class="summary-sig-arg">point1</span>,
<span class="summary-sig-arg">point2</span>,
<span class="summary-sig-arg">color</span>=<span class="summary-sig-default">Color(.564706,.933333,.564706)</span>,
<span class="summary-sig-arg">border</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">colour</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
draw_box(self, (x1, y1), (x2, y2), (x3, y3), (x4, y4),
color=colors.lightgreen)</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#draw_box">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.GenomeDiagram._AbstractDrawer-module.html#draw_polygon" class="summary-sig-name">draw_polygon</a>(<span class="summary-sig-arg">list_of_points</span>,
<span class="summary-sig-arg">color</span>=<span class="summary-sig-default">Color(.564706,.933333,.564706)</span>,
<span class="summary-sig-arg">border</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">colour</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
draw_polygon(self, (x1, y1), (x2, y2), (x3, y3), (x4, y4)
colour=colors.lightgreen)</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#draw_polygon">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 name="draw_arrow"></a><span class="summary-sig-name">draw_arrow</span>(<span class="summary-sig-arg">point1</span>,
<span class="summary-sig-arg">point2</span>,
<span class="summary-sig-arg">color</span>=<span class="summary-sig-default">Color(.564706,.933333,.564706)</span>,
<span class="summary-sig-arg">border</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">shaft_height_ratio</span>=<span class="summary-sig-default">0.4</span>,
<span class="summary-sig-arg">head_length_ratio</span>=<span class="summary-sig-default">0.5</span>,
<span class="summary-sig-arg">orientation</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">right</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">colour</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Returns a closed path object representing an arrow enclosed by the
box with corners at {point1=(x1,y1), point2=(x2,y2)}, a shaft height
given by shaft_height_ratio (relative to box height), a head length
given by head_length_ratio (also relative to box height), and an
orientation that may be 'left' or 'right'.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#draw_arrow">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.GenomeDiagram._AbstractDrawer-module.html#angle2trig" class="summary-sig-name">angle2trig</a>(<span class="summary-sig-arg">angle</span>)</span><br />
o theta Angle in degrees, counter clockwise from horizontal</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#angle2trig">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.GenomeDiagram._AbstractDrawer-module.html#intermediate_points" class="summary-sig-name">intermediate_points</a>(<span class="summary-sig-arg">start</span>,
<span class="summary-sig-arg">end</span>,
<span class="summary-sig-arg">graph_data</span>)</span><br />
o graph_data</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#intermediate_points">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></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">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
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">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'Bio.Graphics.GenomeDiagram'"><code class="variable-quote">'</code><code class="variable-string">Bio.Graphics.GenomeDiagram</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></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">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="page_sizes"></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">page_sizes</span>(<span class="sig-arg">size</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#page_sizes">source code</a></span>
</td>
</tr></table>
<p>o size A string representing a standard page size</p>
<p>Returns a ReportLab pagesize when passed a valid size string</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="draw_box"></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_box</span>(<span class="sig-arg">point1</span>,
<span class="sig-arg">point2</span>,
<span class="sig-arg">color</span>=<span class="sig-default">Color(.564706,.933333,.564706)</span>,
<span class="sig-arg">border</span>=<span class="sig-default">None</span>,
<span class="sig-arg">colour</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#draw_box">source code</a></span>
</td>
</tr></table>
<pre class="literalblock">
draw_box(self, (x1, y1), (x2, y2), (x3, y3), (x4, y4),
color=colors.lightgreen)
o point1, point2 Co-ordinates for opposite corners of the box
(x,y tuples)
o color /colour The color for the box
(colour takes priority over color)
o border Border color for the box
Returns a closed path object, beginning at (x1,y1) going round
the four points in order, and filling with the passed color.
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="draw_polygon"></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_polygon</span>(<span class="sig-arg">list_of_points</span>,
<span class="sig-arg">color</span>=<span class="sig-default">Color(.564706,.933333,.564706)</span>,
<span class="sig-arg">border</span>=<span class="sig-default">None</span>,
<span class="sig-arg">colour</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#draw_polygon">source code</a></span>
</td>
</tr></table>
<pre class="literalblock">
draw_polygon(self, (x1, y1), (x2, y2), (x3, y3), (x4, y4)
colour=colors.lightgreen)
o list_of_point = list of (x,y) tuples for the corner coordinates
o colour The colour for the box
Returns a closed path object, beginning at (x1,y1) going round
the four points in order, and filling with the passed colour.
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="angle2trig"></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">angle2trig</span>(<span class="sig-arg">angle</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#angle2trig">source code</a></span>
</td>
</tr></table>
<p>o theta Angle in degrees, counter clockwise from horizontal</p>
<p>Returns a representation of the passed angle in a format suitable for
ReportLab rotations (i.e. cos(theta), sin(theta), -sin(theta), cos(theta)
tuple)</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="intermediate_points"></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">intermediate_points</span>(<span class="sig-arg">start</span>,
<span class="sig-arg">end</span>,
<span class="sig-arg">graph_data</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Graphics.GenomeDiagram._AbstractDrawer-pysrc.html#intermediate_points">source code</a></span>
</td>
</tr></table>
<p>o graph_data</p>
<p>o start</p>
<p>o end</p>
<p>Returns a list of (start, end, value) tuples describing the passed
graph data as 'bins' between position midpoints.</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:20 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>
