documentation/Strand.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Class: Strand - Documentation</title>
<script src="scripts/prettify/prettify.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-miew.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Strand</h1>
<section>
<header>
<h2>Strand</h2>
<div class="class-description"><p>A single strand of a sheet in a protein secondary structure.</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Strand"><span class="type-signature"></span>new Strand<span class="signature">(sheet, init, term, sense, atomCur, atomPrev)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Create a strand.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sheet</code></td>
<td class="type">
<span class="param-type">Sheet</span>
</td>
<td class="description last"><p>Parent sheet this strand belongs to.</p></td>
</tr>
<tr>
<td class="name"><code>init</code></td>
<td class="type">
<span class="param-type">Residue</span>
</td>
<td class="description last"><p>Initial residue.</p></td>
</tr>
<tr>
<td class="name"><code>term</code></td>
<td class="type">
<span class="param-type">Residue</span>
</td>
<td class="description last"><p>Terminal residue.</p></td>
</tr>
<tr>
<td class="name"><code>sense</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Sense of strand with respect to previous strand in the sheet.</p>
<ul>
<li>0 if the first strand,</li>
<li>1 if parallel, and</li>
<li>-1 if anti-parallel.</li>
</ul></td>
</tr>
<tr>
<td class="name"><code>atomCur</code></td>
<td class="type">
<span class="param-type">Atom</span>
</td>
<td class="description last"><p>Atom in current strand (see PDB Format).</p></td>
</tr>
<tr>
<td class="name"><code>atomPrev</code></td>
<td class="type">
<span class="param-type">Atom</span>
</td>
<td class="description last"><p>Atom in previous strand (see PDB Format).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="StructuralElement.html">StructuralElement</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="atomCur"><span class="type-signature"></span>atomCur<span class="type-signature"> :Atom</span></h4>
<div class="description">
<p>Atom in current strand (see PDB Format).</p>
</div>
<dl class="details">
</dl>
<h4 class="name" id="atomPrev"><span class="type-signature"></span>atomPrev<span class="type-signature"> :Atom</span></h4>
<div class="description">
<p>Atom in previous strand (see PDB Format).</p>
</div>
<dl class="details">
</dl>
<h4 class="name" id="generic"><span class="type-signature"></span>generic<span class="type-signature"> :<a href="StructuralElement.html#.Generic">StructuralElement.Generic</a></span></h4>
<div class="description">
<p>Generic secondary structure type.</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="StructuralElement.html#generic">StructuralElement#generic</a>
</li></ul></dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="type-signature"> :Residue</span></h4>
<div class="description">
<p>Initial residue.</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="StructuralElement.html#init">StructuralElement#init</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sense"><span class="type-signature"></span>sense<span class="type-signature"> :number</span></h4>
<div class="description">
<p>Sense of strand with respect to previous strand in the sheet.</p>
<ul>
<li>0 if the first strand,</li>
<li>1 if parallel, and</li>
<li>-1 if anti-parallel.</li>
</ul>
</div>
<dl class="details">
</dl>
<h4 class="name" id="sheet"><span class="type-signature"></span>sheet<span class="type-signature"> :Sheet</span></h4>
<div class="description">
<p>Parent sheet this strand belongs to.</p>
</div>
<dl class="details">
</dl>
<h4 class="name" id="term"><span class="type-signature"></span>term<span class="type-signature"> :Residue</span></h4>
<div class="description">
<p>Terminal residue.</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="StructuralElement.html#term">StructuralElement#term</a>
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :<a href="StructuralElement.html#.Type">StructuralElement.Type</a></span></h4>
<div class="description">
<p>Secondary structure type.</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="StructuralElement.html#type">StructuralElement#type</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="SettingsObject.html">SettingsObject</a></li></ul><h3>Classes</h3><ul><li><a href="EntityList.html">EntityList</a></li><li><a href="EventDispatcher.html">EventDispatcher</a></li><li><a href="GROParser.html">GROParser</a></li><li><a href="GROReader.html">GROReader</a></li><li><a href="Helix.html">Helix</a></li><li><a href="LoaderList.html">LoaderList</a></li><li><a href="Logger.html">Logger</a></li><li><a href="Miew.html">Miew</a></li><li><a href="ParserList.html">ParserList</a></li><li><a href="PDBStream.html">PDBStream</a></li><li><a href="Strand.html">Strand</a></li><li><a href="StructuralElement.html">StructuralElement</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-embed.html">Embedding the Viewer</a></li><li><a href="tutorial-events.html">events</a></li><li><a href="tutorial-selectors.html">Selection Language</a></li><li><a href="tutorial-url.html">URL Query String</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Dec 16 2021 21:46:10 GMT+0300 (Москва, стандартное время)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>