123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>LoadParams | @rcsb/rcsb-saguaro-3d</title>
- <meta name="description" content="Documentation for @rcsb/rcsb-saguaro-3d">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link rel="stylesheet" href="../assets/css/main.css">
- </head>
- <body>
- <header>
- <div class="tsd-page-toolbar">
- <div class="container">
- <div class="table-wrap">
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div class="field">
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
- </div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
- <a href="../index.html" class="title">@rcsb/rcsb-saguaro-3d</a>
- </div>
- <div class="table-cell" id="tsd-widgets">
- <div id="tsd-filter">
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
- <div class="tsd-filter-group">
- <div class="tsd-select" id="tsd-filter-visibility">
- <span class="tsd-select-label">All</span>
- <ul class="tsd-select-list">
- <li data-value="public">Public</li>
- <li data-value="protected">Public/Protected</li>
- <li data-value="private" class="selected">All</li>
- </ul>
- </div>
- <input type="checkbox" id="tsd-filter-inherited" checked />
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
- <input type="checkbox" id="tsd-filter-externals" checked />
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
- <input type="checkbox" id="tsd-filter-only-exported" />
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
- </div>
- </div>
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
- </div>
- </div>
- </div>
- </div>
- <div class="tsd-page-title">
- <div class="container">
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../globals.html">Globals</a>
- </li>
- <li>
- <a href="loadparams.html">LoadParams</a>
- </li>
- </ul>
- <h1>Interface LoadParams<P, S></h1>
- </div>
- </div>
- </header>
- <div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <section class="tsd-panel tsd-type-parameters">
- <h3>Type parameters</h3>
- <ul class="tsd-type-parameters">
- <li>
- <h4>P</h4>
- </li>
- <li>
- <h4>S</h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-hierarchy">
- <h3>Hierarchy</h3>
- <ul class="tsd-hierarchy">
- <li>
- <span class="target">LoadParams</span>
- </li>
- </ul>
- </section>
- <section class="tsd-panel-group tsd-index-group">
- <h2>Index</h2>
- <section class="tsd-panel tsd-index-panel">
- <div class="tsd-index-content">
- <section class="tsd-index-section ">
- <h3>Properties</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#data" class="tsd-kind-icon">data</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#format" class="tsd-kind-icon">format</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#id" class="tsd-kind-icon">id</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#isbinary" class="tsd-kind-icon">is<wbr>Binary</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#matrix" class="tsd-kind-icon">matrix</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#params" class="tsd-kind-icon">params</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#pdbid" class="tsd-kind-icon">pdb<wbr>Id</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#props" class="tsd-kind-icon">props</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#reprprovider" class="tsd-kind-icon">repr<wbr>Provider</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#type" class="tsd-kind-icon">type</a></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#url" class="tsd-kind-icon">url</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Properties</h2>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="data" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> data</h3>
- <div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:56</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="format" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> format</h3>
- <div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BuiltInTrajectoryFormat</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:53</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="id" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
- <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:57</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="isbinary" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Binary</h3>
- <div class="tsd-signature tsd-kind-icon">is<wbr>Binary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:54</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="matrix" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> matrix</h3>
- <div class="tsd-signature tsd-kind-icon">matrix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Mat4</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:51</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="params" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> params</h3>
- <div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type">P</a></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:59</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="pdbid" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> pdb<wbr>Id</h3>
- <div class="tsd-signature tsd-kind-icon">pdb<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:49</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="props" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> props</h3>
- <div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PresetProps</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:50</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="reprprovider" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> repr<wbr>Provider</h3>
- <div class="tsd-signature tsd-kind-icon">repr<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TrajectoryHierarchyPresetProvider</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:58</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="type" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
- <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PluginState.SnapshotType</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:55</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
- <a name="url" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3>
- <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:52</li>
- </ul>
- </aside>
- </section>
- </section>
- </div>
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
- <nav class="tsd-navigation primary">
- <ul>
- <li class="globals ">
- <a href="../globals.html"><em>Globals</em></a>
- </li>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- </ul>
- <ul class="current">
- <li class="current tsd-kind-interface tsd-has-type-parameter">
- <a href="loadparams.html" class="tsd-kind-icon">Load<wbr>Params</a>
- <ul>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#data" class="tsd-kind-icon">data</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#format" class="tsd-kind-icon">format</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#id" class="tsd-kind-icon">id</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#isbinary" class="tsd-kind-icon">is<wbr>Binary</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#matrix" class="tsd-kind-icon">matrix</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#params" class="tsd-kind-icon">params</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#pdbid" class="tsd-kind-icon">pdb<wbr>Id</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#props" class="tsd-kind-icon">props</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#reprprovider" class="tsd-kind-icon">repr<wbr>Provider</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#type" class="tsd-kind-icon">type</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-interface">
- <a href="loadparams.html#url" class="tsd-kind-icon">url</a>
- </li>
- </ul>
- </li>
- </ul>
- <ul class="after-current">
- </ul>
- </nav>
- </div>
- </div>
- </div>
- <footer class="with-border-bottom">
- <div class="container">
- <h2>Legend</h2>
- <div class="tsd-legend-group">
- <ul class="tsd-legend">
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
- </ul>
- </div>
- </div>
- </footer>
- <div class="container tsd-generator">
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
- </div>
- <div class="overlay"></div>
- <script src="../assets/js/main.js"></script>
- </body>
- </html>
|