loadparams.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>LoadParams | @rcsb/rcsb-saguaro-3d</title>
  7. <meta name="description" content="Documentation for @rcsb/rcsb-saguaro-3d">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="../index.html" class="title">@rcsb/rcsb-saguaro-3d</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. <input type="checkbox" id="tsd-filter-only-exported" />
  44. <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
  45. </div>
  46. </div>
  47. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  48. </div>
  49. </div>
  50. </div>
  51. </div>
  52. <div class="tsd-page-title">
  53. <div class="container">
  54. <ul class="tsd-breadcrumb">
  55. <li>
  56. <a href="../globals.html">Globals</a>
  57. </li>
  58. <li>
  59. <a href="loadparams.html">LoadParams</a>
  60. </li>
  61. </ul>
  62. <h1>Interface LoadParams&lt;P, S&gt;</h1>
  63. </div>
  64. </div>
  65. </header>
  66. <div class="container container-main">
  67. <div class="row">
  68. <div class="col-8 col-content">
  69. <section class="tsd-panel tsd-type-parameters">
  70. <h3>Type parameters</h3>
  71. <ul class="tsd-type-parameters">
  72. <li>
  73. <h4>P</h4>
  74. </li>
  75. <li>
  76. <h4>S</h4>
  77. </li>
  78. </ul>
  79. </section>
  80. <section class="tsd-panel tsd-hierarchy">
  81. <h3>Hierarchy</h3>
  82. <ul class="tsd-hierarchy">
  83. <li>
  84. <span class="target">LoadParams</span>
  85. </li>
  86. </ul>
  87. </section>
  88. <section class="tsd-panel-group tsd-index-group">
  89. <h2>Index</h2>
  90. <section class="tsd-panel tsd-index-panel">
  91. <div class="tsd-index-content">
  92. <section class="tsd-index-section ">
  93. <h3>Properties</h3>
  94. <ul class="tsd-index-list">
  95. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#data" class="tsd-kind-icon">data</a></li>
  96. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#format" class="tsd-kind-icon">format</a></li>
  97. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#id" class="tsd-kind-icon">id</a></li>
  98. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#isbinary" class="tsd-kind-icon">is<wbr>Binary</a></li>
  99. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#matrix" class="tsd-kind-icon">matrix</a></li>
  100. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#params" class="tsd-kind-icon">params</a></li>
  101. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#pdbid" class="tsd-kind-icon">pdb<wbr>Id</a></li>
  102. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#props" class="tsd-kind-icon">props</a></li>
  103. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#reprprovider" class="tsd-kind-icon">repr<wbr>Provider</a></li>
  104. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#type" class="tsd-kind-icon">type</a></li>
  105. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="loadparams.html#url" class="tsd-kind-icon">url</a></li>
  106. </ul>
  107. </section>
  108. </div>
  109. </section>
  110. </section>
  111. <section class="tsd-panel-group tsd-member-group ">
  112. <h2>Properties</h2>
  113. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  114. <a name="data" class="tsd-anchor"></a>
  115. <h3><span class="tsd-flag ts-flagOptional">Optional</span> data</h3>
  116. <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>
  117. <aside class="tsd-sources">
  118. <ul>
  119. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:56</li>
  120. </ul>
  121. </aside>
  122. </section>
  123. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  124. <a name="format" class="tsd-anchor"></a>
  125. <h3><span class="tsd-flag ts-flagOptional">Optional</span> format</h3>
  126. <div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BuiltInTrajectoryFormat</span></div>
  127. <aside class="tsd-sources">
  128. <ul>
  129. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:53</li>
  130. </ul>
  131. </aside>
  132. </section>
  133. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  134. <a name="id" class="tsd-anchor"></a>
  135. <h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
  136. <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>
  137. <aside class="tsd-sources">
  138. <ul>
  139. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:57</li>
  140. </ul>
  141. </aside>
  142. </section>
  143. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  144. <a name="isbinary" class="tsd-anchor"></a>
  145. <h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Binary</h3>
  146. <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>
  147. <aside class="tsd-sources">
  148. <ul>
  149. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:54</li>
  150. </ul>
  151. </aside>
  152. </section>
  153. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  154. <a name="matrix" class="tsd-anchor"></a>
  155. <h3><span class="tsd-flag ts-flagOptional">Optional</span> matrix</h3>
  156. <div class="tsd-signature tsd-kind-icon">matrix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Mat4</span></div>
  157. <aside class="tsd-sources">
  158. <ul>
  159. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:51</li>
  160. </ul>
  161. </aside>
  162. </section>
  163. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  164. <a name="params" class="tsd-anchor"></a>
  165. <h3><span class="tsd-flag ts-flagOptional">Optional</span> params</h3>
  166. <div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type">P</a></div>
  167. <aside class="tsd-sources">
  168. <ul>
  169. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:59</li>
  170. </ul>
  171. </aside>
  172. </section>
  173. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  174. <a name="pdbid" class="tsd-anchor"></a>
  175. <h3><span class="tsd-flag ts-flagOptional">Optional</span> pdb<wbr>Id</h3>
  176. <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>
  177. <aside class="tsd-sources">
  178. <ul>
  179. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:49</li>
  180. </ul>
  181. </aside>
  182. </section>
  183. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  184. <a name="props" class="tsd-anchor"></a>
  185. <h3><span class="tsd-flag ts-flagOptional">Optional</span> props</h3>
  186. <div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PresetProps</span></div>
  187. <aside class="tsd-sources">
  188. <ul>
  189. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:50</li>
  190. </ul>
  191. </aside>
  192. </section>
  193. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  194. <a name="reprprovider" class="tsd-anchor"></a>
  195. <h3><span class="tsd-flag ts-flagOptional">Optional</span> repr<wbr>Provider</h3>
  196. <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">&lt;</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">&gt;</span></div>
  197. <aside class="tsd-sources">
  198. <ul>
  199. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:58</li>
  200. </ul>
  201. </aside>
  202. </section>
  203. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  204. <a name="type" class="tsd-anchor"></a>
  205. <h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
  206. <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PluginState.SnapshotType</span></div>
  207. <aside class="tsd-sources">
  208. <ul>
  209. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:55</li>
  210. </ul>
  211. </aside>
  212. </section>
  213. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  214. <a name="url" class="tsd-anchor"></a>
  215. <h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3>
  216. <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>
  217. <aside class="tsd-sources">
  218. <ul>
  219. <li>Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:52</li>
  220. </ul>
  221. </aside>
  222. </section>
  223. </section>
  224. </div>
  225. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  226. <nav class="tsd-navigation primary">
  227. <ul>
  228. <li class="globals ">
  229. <a href="../globals.html"><em>Globals</em></a>
  230. </li>
  231. </ul>
  232. </nav>
  233. <nav class="tsd-navigation secondary menu-sticky">
  234. <ul class="before-current">
  235. </ul>
  236. <ul class="current">
  237. <li class="current tsd-kind-interface tsd-has-type-parameter">
  238. <a href="loadparams.html" class="tsd-kind-icon">Load<wbr>Params</a>
  239. <ul>
  240. <li class=" tsd-kind-property tsd-parent-kind-interface">
  241. <a href="loadparams.html#data" class="tsd-kind-icon">data</a>
  242. </li>
  243. <li class=" tsd-kind-property tsd-parent-kind-interface">
  244. <a href="loadparams.html#format" class="tsd-kind-icon">format</a>
  245. </li>
  246. <li class=" tsd-kind-property tsd-parent-kind-interface">
  247. <a href="loadparams.html#id" class="tsd-kind-icon">id</a>
  248. </li>
  249. <li class=" tsd-kind-property tsd-parent-kind-interface">
  250. <a href="loadparams.html#isbinary" class="tsd-kind-icon">is<wbr>Binary</a>
  251. </li>
  252. <li class=" tsd-kind-property tsd-parent-kind-interface">
  253. <a href="loadparams.html#matrix" class="tsd-kind-icon">matrix</a>
  254. </li>
  255. <li class=" tsd-kind-property tsd-parent-kind-interface">
  256. <a href="loadparams.html#params" class="tsd-kind-icon">params</a>
  257. </li>
  258. <li class=" tsd-kind-property tsd-parent-kind-interface">
  259. <a href="loadparams.html#pdbid" class="tsd-kind-icon">pdb<wbr>Id</a>
  260. </li>
  261. <li class=" tsd-kind-property tsd-parent-kind-interface">
  262. <a href="loadparams.html#props" class="tsd-kind-icon">props</a>
  263. </li>
  264. <li class=" tsd-kind-property tsd-parent-kind-interface">
  265. <a href="loadparams.html#reprprovider" class="tsd-kind-icon">repr<wbr>Provider</a>
  266. </li>
  267. <li class=" tsd-kind-property tsd-parent-kind-interface">
  268. <a href="loadparams.html#type" class="tsd-kind-icon">type</a>
  269. </li>
  270. <li class=" tsd-kind-property tsd-parent-kind-interface">
  271. <a href="loadparams.html#url" class="tsd-kind-icon">url</a>
  272. </li>
  273. </ul>
  274. </li>
  275. </ul>
  276. <ul class="after-current">
  277. </ul>
  278. </nav>
  279. </div>
  280. </div>
  281. </div>
  282. <footer class="with-border-bottom">
  283. <div class="container">
  284. <h2>Legend</h2>
  285. <div class="tsd-legend-group">
  286. <ul class="tsd-legend">
  287. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  288. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  289. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  290. </ul>
  291. <ul class="tsd-legend">
  292. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  293. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  294. </ul>
  295. <ul class="tsd-legend">
  296. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  297. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  298. </ul>
  299. <ul class="tsd-legend">
  300. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  301. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  302. </ul>
  303. <ul class="tsd-legend">
  304. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  305. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  306. </ul>
  307. </div>
  308. </div>
  309. </footer>
  310. <div class="container tsd-generator">
  311. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  312. </div>
  313. <div class="overlay"></div>
  314. <script src="../assets/js/main.js"></script>
  315. </body>
  316. </html>