|
|
@@ -366,15 +366,20 @@ document.addEventListener("DOMContentLoaded", function (event) {
|
|
|
</a>
|
|
|
<pre><code>npm <span class="hljs-builtin-name">run</span> buildExamples</code></pre><p>From the root of the project:</p>
|
|
|
<pre><code>http-server -p PORT-<span class="hljs-built_in">NUMBER</span></code></pre><p>and navigate to <code>localhost:PORT-NUMBER/build/examples/</code></p>
|
|
|
- <a href="#main-classes-and-methods" id="main-classes-and-methods" style="color: inherit; text-decoration: none;">
|
|
|
- <h3>Main Classes and Methods</h3>
|
|
|
+ <a href="#library-documentation" id="library-documentation" style="color: inherit; text-decoration: none;">
|
|
|
+ <h3>Library Documentation</h3>
|
|
|
+ </a>
|
|
|
+ <p>TypeScript full classes documentation can be found <a href="https://rcsb.github.io/rcsb-saguaro-3d/globals.html">here</a>.</p>
|
|
|
+ <a href="#main-classes-and-interfaces" id="main-classes-and-interfaces" style="color: inherit; text-decoration: none;">
|
|
|
+ <h3>Main Classes and Interfaces</h3>
|
|
|
</a>
|
|
|
<a href="#assembly-view" id="assembly-view" style="color: inherit; text-decoration: none;">
|
|
|
<h4>Assembly view</h4>
|
|
|
</a>
|
|
|
- <p>Class <strong><code>RcsbFv3DAssembly</code></strong> (<code>src/RcsbFv3D/RcsbFv3DAssembly.tsx</code>) builds a predefined view for PDB entries. This method is used in the RCSB PDB web portal
|
|
|
+ <p>Class <strong><code>RcsbFv3DAssembly</code></strong> (<code>src/RcsbFv3D/RcsbFv3DAssembly.tsx</code>) builds a predefined 1D/3D view for PDB entries. This method is used in the RCSB PDB web portal
|
|
|
to display 1D features on PDB entries (ex: <a href="https://www.rcsb.org/3d-sequence/4HHB">4hhb</a>). Its configuration requires a single PDB ID.
|
|
|
- In addition, <code>RcsbFvAdditionalConfig</code> allows to configure the feature viewer as describe in <a href="%22https://rcsb.github.io/rcsb-saguaro-app/index.html%22">rcsb-saguaro-app API</a></p>
|
|
|
+ In addition, <code>additionalConfig</code> allows to configure the feature viewer as describe in rcsb-saguaro-app <a href="%22https://rcsb.github.io/rcsb-saguaro-app/interfaces/rcsbfvadditionalconfig.html%22">API</a>.
|
|
|
+ This parameter exposes the board configuration through the attribute <code>boardConfig</code> (<a href="%22https://rcsb.github.io/rcsb-saguaro/interfaces/rcsbfvboardconfiginterface.html%22">ref</a>). </p>
|
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">interface</span> RcsbFv3DAssemblyInterface <span class="hljs-keyword">extends</span> RcsbFv3DAbstractInterface {
|
|
|
<span class="hljs-attr">config</span>: {
|
|
|
<span class="hljs-attr">entryId</span>: <span class="hljs-built_in">string</span>;
|
|
|
@@ -431,9 +436,15 @@ document.addEventListener("DOMContentLoaded", function (event) {
|
|
|
sequenceSelectionChangeCallback: <span class="hljs-function">(<span class="hljs-params">plugin: SaguaroPluginPublicInterface, selectorManager: RcsbFvSelectorManager, sequenceRegion: <span class="hljs-built_in">Array</span><RcsbFvTrackDataElementInterface></span>) =></span> <span class="hljs-built_in">void</span>;
|
|
|
sequenceElementClickCallback: <span class="hljs-function">(<span class="hljs-params">plugin: SaguaroPluginPublicInterface, selectorManager: RcsbFvSelectorManager, d: RcsbFvTrackDataElementInterface</span>) =></span> <span class="hljs-built_in">void</span>;
|
|
|
sequenceHoverCallback: <span class="hljs-function">(<span class="hljs-params">plugin: SaguaroPluginPublicInterface, selectorManager: RcsbFvSelectorManager, hoverRegion: <span class="hljs-built_in">Array</span><RcsbFvTrackDataElementInterface></span>) =></span> <span class="hljs-built_in">void</span>;
|
|
|
- structureSelectionCallback: <span class="hljs-function">(<span class="hljs-params">plugin: SaguaroPluginPublicInterface, pfv: RcsbFv, selection: RcsbFvSelectorManager</span>) =></span> <span class="hljs-built_in">void</span>;
|
|
|
- structureHoverCallback: <span class="hljs-function">(<span class="hljs-params">plugin: SaguaroPluginPublicInterface, pfv: RcsbFv, selection: RcsbFvSelectorManager</span>) =></span> <span class="hljs-built_in">void</span>;
|
|
|
+ structureSelectionCallback: <span class="hljs-function">(<span class="hljs-params">plugin: SaguaroPluginPublicInterface, pfv: RcsbFv, selectorManager: RcsbFvSelectorManager</span>) =></span> <span class="hljs-built_in">void</span>;
|
|
|
+ structureHoverCallback: <span class="hljs-function">(<span class="hljs-params">plugin: SaguaroPluginPublicInterface, pfv: RcsbFv, selectorManager: RcsbFvSelectorManager</span>) =></span> <span class="hljs-built_in">void</span>;
|
|
|
}</code></pre>
|
|
|
+ <p><code>plugin: SaguaroPluginPublicInterface</code> exposes the interface to interact with the molstar plugin
|
|
|
+ and change model representations (<a href="%22https://rcsb.github.io/rcsb-saguaro-3d/interfaces/saguaropluginpublicinterface.html%22">ref</a>).
|
|
|
+ It provides multiple methods such as hide, display or select to modify how structural data is displayed. The parameter <code>pfv: RcsbFv</code>
|
|
|
+ allows to access the feature viewer API (<a href="%22https://rcsb.github.io/rcsb-saguaro/classes/rcsbfv.html%22">ref</a>). It exposes methods to modify
|
|
|
+ selections, change board configuration, zoom or adding new tracks.</p>
|
|
|
+ <p>Source code example can be found in <code>src/examples/single-chain/index.tsx</code></p>
|
|
|
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
|
|
|
<h2>Contributing</h2>
|
|
|
</a>
|
bioinsilico