rcsbfv3dassemblyinterface.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  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>RcsbFv3DAssemblyInterface | @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="rcsbfv3dassemblyinterface.html">RcsbFv3DAssemblyInterface</a>
  60. </li>
  61. </ul>
  62. <h1>Interface RcsbFv3DAssemblyInterface</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-hierarchy">
  70. <h3>Hierarchy</h3>
  71. <ul class="tsd-hierarchy">
  72. <li>
  73. <a href="rcsbfv3dabstractinterface.html" class="tsd-signature-type">RcsbFv3DAbstractInterface</a>
  74. <ul class="tsd-hierarchy">
  75. <li>
  76. <span class="target">RcsbFv3DAssemblyInterface</span>
  77. </li>
  78. </ul>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="tsd-panel-group tsd-index-group">
  83. <h2>Index</h2>
  84. <section class="tsd-panel tsd-index-panel">
  85. <div class="tsd-index-content">
  86. <section class="tsd-index-section ">
  87. <h3>Properties</h3>
  88. <ul class="tsd-index-list">
  89. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="rcsbfv3dassemblyinterface.html#additionalconfig" class="tsd-kind-icon">additional<wbr>Config</a></li>
  90. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="rcsbfv3dassemblyinterface.html#config" class="tsd-kind-icon">config</a></li>
  91. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="rcsbfv3dassemblyinterface.html#cssconfig" class="tsd-kind-icon">css<wbr>Config</a></li>
  92. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="rcsbfv3dassemblyinterface.html#elementid" class="tsd-kind-icon">element<wbr>Id</a></li>
  93. </ul>
  94. </section>
  95. </div>
  96. </section>
  97. </section>
  98. <section class="tsd-panel-group tsd-member-group ">
  99. <h2>Properties</h2>
  100. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  101. <a name="additionalconfig" class="tsd-anchor"></a>
  102. <h3><span class="tsd-flag ts-flagOptional">Optional</span> additional<wbr>Config</h3>
  103. <div class="tsd-signature tsd-kind-icon">additional<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RcsbFvAdditionalConfig</span></div>
  104. <aside class="tsd-sources">
  105. <ul>
  106. <li>Defined in src/RcsbFv3D/RcsbFv3DAssembly.tsx:12</li>
  107. </ul>
  108. </aside>
  109. </section>
  110. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  111. <a name="config" class="tsd-anchor"></a>
  112. <h3>config</h3>
  113. <div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>entryId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>subtitle<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><span class="tsd-signature-symbol">; </span>title<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><span class="tsd-signature-symbol"> }</span></div>
  114. <aside class="tsd-sources">
  115. <ul>
  116. <li>Defined in src/RcsbFv3D/RcsbFv3DAssembly.tsx:7</li>
  117. </ul>
  118. </aside>
  119. <div class="tsd-type-declaration">
  120. <h4>Type declaration</h4>
  121. <ul class="tsd-parameters">
  122. <li class="tsd-parameter">
  123. <h5>entry<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
  124. </li>
  125. <li class="tsd-parameter">
  126. <h5><span class="tsd-flag ts-flagOptional">Optional</span> subtitle<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></h5>
  127. </li>
  128. <li class="tsd-parameter">
  129. <h5><span class="tsd-flag ts-flagOptional">Optional</span> title<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></h5>
  130. </li>
  131. </ul>
  132. </div>
  133. </section>
  134. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  135. <a name="cssconfig" class="tsd-anchor"></a>
  136. <h3><span class="tsd-flag ts-flagOptional">Optional</span> css<wbr>Config</h3>
  137. <div class="tsd-signature tsd-kind-icon">css<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="rcsbfv3dcssconfig.html" class="tsd-signature-type">RcsbFv3DCssConfig</a></div>
  138. <aside class="tsd-sources">
  139. <p>Inherited from <a href="rcsbfv3dabstractinterface.html">RcsbFv3DAbstractInterface</a>.<a href="rcsbfv3dabstractinterface.html#cssconfig">cssConfig</a></p>
  140. <ul>
  141. <li>Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:12</li>
  142. </ul>
  143. </aside>
  144. </section>
  145. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  146. <a name="elementid" class="tsd-anchor"></a>
  147. <h3>element<wbr>Id</h3>
  148. <div class="tsd-signature tsd-kind-icon">element<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  149. <aside class="tsd-sources">
  150. <p>Inherited from <a href="rcsbfv3dabstractinterface.html">RcsbFv3DAbstractInterface</a>.<a href="rcsbfv3dabstractinterface.html#elementid">elementId</a></p>
  151. <ul>
  152. <li>Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:11</li>
  153. </ul>
  154. </aside>
  155. </section>
  156. </section>
  157. </div>
  158. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  159. <nav class="tsd-navigation primary">
  160. <ul>
  161. <li class="globals ">
  162. <a href="../globals.html"><em>Globals</em></a>
  163. </li>
  164. </ul>
  165. </nav>
  166. <nav class="tsd-navigation secondary menu-sticky">
  167. <ul class="before-current">
  168. </ul>
  169. <ul class="current">
  170. <li class="current tsd-kind-interface">
  171. <a href="rcsbfv3dassemblyinterface.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DAssembly<wbr>Interface</a>
  172. <ul>
  173. <li class=" tsd-kind-property tsd-parent-kind-interface">
  174. <a href="rcsbfv3dassemblyinterface.html#additionalconfig" class="tsd-kind-icon">additional<wbr>Config</a>
  175. </li>
  176. <li class=" tsd-kind-property tsd-parent-kind-interface">
  177. <a href="rcsbfv3dassemblyinterface.html#config" class="tsd-kind-icon">config</a>
  178. </li>
  179. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  180. <a href="rcsbfv3dassemblyinterface.html#cssconfig" class="tsd-kind-icon">css<wbr>Config</a>
  181. </li>
  182. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  183. <a href="rcsbfv3dassemblyinterface.html#elementid" class="tsd-kind-icon">element<wbr>Id</a>
  184. </li>
  185. </ul>
  186. </li>
  187. </ul>
  188. <ul class="after-current">
  189. </ul>
  190. </nav>
  191. </div>
  192. </div>
  193. </div>
  194. <footer class="with-border-bottom">
  195. <div class="container">
  196. <h2>Legend</h2>
  197. <div class="tsd-legend-group">
  198. <ul class="tsd-legend">
  199. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  200. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  201. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  202. </ul>
  203. <ul class="tsd-legend">
  204. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  205. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  206. </ul>
  207. <ul class="tsd-legend">
  208. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  209. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  210. </ul>
  211. <ul class="tsd-legend">
  212. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  213. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  214. </ul>
  215. <ul class="tsd-legend">
  216. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  217. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  218. </ul>
  219. </div>
  220. </div>
  221. </footer>
  222. <div class="container tsd-generator">
  223. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  224. </div>
  225. <div class="overlay"></div>
  226. <script src="../assets/js/main.js"></script>
  227. </body>
  228. </html>