<?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.BasicChromosome.ChromosomeSegment</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.BasicChromosome-module.html">Module BasicChromosome</a> :: Class ChromosomeSegment </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.BasicChromosome.ChromosomeSegment-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class ChromosomeSegment</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment">source code</a></span></p> <pre class="base-tree"> reportlab.graphics.widgetbase.PropHolder --+ | reportlab.graphics.shapes._DrawTimeResizeable --+ | | | reportlab.graphics.shapes.UserNode --+ | reportlab.graphics.widgetbase.Widget --+ | <a href="Bio.Graphics.BasicChromosome._ChromosomeComponent-class.html" onclick="show_private();">_ChromosomeComponent</a> --+ | <strong class="uidshort">ChromosomeSegment</strong> </pre> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="Bio.Graphics.BasicChromosome.TelomereSegment-class.html">TelomereSegment</a></li> </ul> </dd></dl> <hr /> <p>Draw a segment of a chromosome.</p> <p>This class provides the important configurable functionality of drawing a Chromosome. Each segment has some customization available here, or can be subclassed to define additional functionality. Most of the interesting drawing stuff is likely to happen at the ChromosomeSegment level.</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.BasicChromosome.ChromosomeSegment-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br /> Initialize a ChromosomeSegment.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment.__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.BasicChromosome.ChromosomeSegment-class.html#draw" class="summary-sig-name">draw</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">cur_drawing</span>)</span><br /> Draw a chromosome segment.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment.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 href="Bio.Graphics.BasicChromosome.ChromosomeSegment-class.html#_draw_subcomponents" class="summary-sig-name" onclick="show_private();">_draw_subcomponents</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">cur_drawing</span>)</span><br /> Draw any subcomponents of the chromosome segment.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment._draw_subcomponents">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_segment"></a><span class="summary-sig-name">_draw_segment</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">cur_drawing</span>)</span><br /> Draw the current chromosome segment.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment._draw_segment">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_label"></a><span class="summary-sig-name">_draw_label</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">cur_drawing</span>)</span><br /> Add a label to the chromosome segment.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment._draw_label">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Bio.Graphics.BasicChromosome._ChromosomeComponent-class.html" onclick="show_private();">_ChromosomeComponent</a></code></b>: <code><a href="Bio.Graphics.BasicChromosome._ChromosomeComponent-class.html#add">add</a></code>, <code><a href="Bio.Graphics.BasicChromosome._ChromosomeComponent-class.html#remove">remove</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>reportlab.graphics.widgetbase.Widget</code></b>: <code>demo</code>, <code>getBounds</code>, <code>provideNode</code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>reportlab.graphics.widgetbase.Widget</code></b> (private): <code>_setKeywords</code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code>reportlab.graphics.widgetbase.PropHolder</code></b>: <code>__setattr__</code>, <code>dumpProperties</code>, <code>getProperties</code>, <code>setProperties</code>, <code>verify</code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>reportlab.graphics.shapes._DrawTimeResizeable</code></b> (private): <code>_drawTimeResize</code> </p></div> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></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">Class Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-ClassVariables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>reportlab.graphics.widgetbase.PropHolder</code></b> (private): <code>_attrMap</code> </p></div> </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> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment.__init__">source code</a></span> </td> </tr></table> <p>Initialize a ChromosomeSegment.</p> <p>Attributes: o start_x_position, end_x_position - Defines the x range we have to draw things in.</p> <p>o start_y_position, end_y_position - Defines the y range we have to draw things in.</p> <p>Configuration Attributes:</p> <p>o scale - A scaling value for the component. By default this is set at 1 (ie -- has the same scale as everything else). Higher values give more size to the component, smaller values give less.</p> <p>o fill_color - A color to fill in the segment with. Colors are available in reportlab.lib.colors</p> <p>o label - A label to place on the chromosome segment. This should be a text string specifying what is to be included in the label.</p> <p>o label_size - The size of the label.</p> <p>o chr_percent - The percentage of area that the chromosome segment takes up.</p> <dl class="fields"> <dt>Overrides: <a href="Bio.Graphics.BasicChromosome._ChromosomeComponent-class.html#__init__">_ChromosomeComponent.__init__</a> </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">cur_drawing</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment.draw">source code</a></span> </td> </tr></table> <p>Draw a chromosome segment.</p> <p>Before drawing, the range we are drawing in needs to be set.</p> <dl class="fields"> <dt>Overrides: reportlab.graphics.widgetbase.Widget.draw </dt> </dl> </td></tr></table> </div> <a name="_draw_subcomponents"></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_subcomponents</span>(<span class="sig-arg">self</span>, <span class="sig-arg">cur_drawing</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.Graphics.BasicChromosome-pysrc.html#ChromosomeSegment._draw_subcomponents">source code</a></span> </td> </tr></table> <p>Draw any subcomponents of the chromosome segment.</p> <p>This should be overridden in derived classes if there are subcomponents to be drawn.</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 Mon Sep 15 09:26:35 2008 </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>