abstractviewinterface.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  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>AbstractViewInterface | @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="abstractviewinterface.html">AbstractViewInterface</a>
  60. </li>
  61. </ul>
  62. <h1>Interface AbstractViewInterface</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. <span class="target">AbstractViewInterface</span>
  74. </li>
  75. </ul>
  76. </section>
  77. <section class="tsd-panel-group tsd-index-group">
  78. <h2>Index</h2>
  79. <section class="tsd-panel tsd-index-panel">
  80. <div class="tsd-index-content">
  81. <section class="tsd-index-section ">
  82. <h3>Properties</h3>
  83. <ul class="tsd-index-list">
  84. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="abstractviewinterface.html#componentid" class="tsd-kind-icon">component<wbr>Id</a></li>
  85. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="abstractviewinterface.html#plugin" class="tsd-kind-icon">plugin</a></li>
  86. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="abstractviewinterface.html#selectormanager" class="tsd-kind-icon">selector<wbr>Manager</a></li>
  87. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="abstractviewinterface.html#subtitle" class="tsd-kind-icon">subtitle</a></li>
  88. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="abstractviewinterface.html#title" class="tsd-kind-icon">title</a></li>
  89. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="abstractviewinterface.html#unmount" class="tsd-kind-icon">unmount</a></li>
  90. </ul>
  91. </section>
  92. </div>
  93. </section>
  94. </section>
  95. <section class="tsd-panel-group tsd-member-group ">
  96. <h2>Properties</h2>
  97. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  98. <a name="componentid" class="tsd-anchor"></a>
  99. <h3>component<wbr>Id</h3>
  100. <div class="tsd-signature tsd-kind-icon">component<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  101. <aside class="tsd-sources">
  102. <ul>
  103. <li>Defined in src/RcsbFvSequence/SequenceViews/AbstractView.tsx:14</li>
  104. </ul>
  105. </aside>
  106. </section>
  107. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  108. <a name="plugin" class="tsd-anchor"></a>
  109. <h3>plugin</h3>
  110. <div class="tsd-signature tsd-kind-icon">plugin<span class="tsd-signature-symbol">:</span> <a href="saguaroplugininterface.html" class="tsd-signature-type">SaguaroPluginInterface</a></div>
  111. <aside class="tsd-sources">
  112. <ul>
  113. <li>Defined in src/RcsbFvSequence/SequenceViews/AbstractView.tsx:17</li>
  114. </ul>
  115. </aside>
  116. </section>
  117. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  118. <a name="selectormanager" class="tsd-anchor"></a>
  119. <h3>selector<wbr>Manager</h3>
  120. <div class="tsd-signature tsd-kind-icon">selector<wbr>Manager<span class="tsd-signature-symbol">:</span> <a href="../classes/rcsbfvselectormanager.html" class="tsd-signature-type">RcsbFvSelectorManager</a></div>
  121. <aside class="tsd-sources">
  122. <ul>
  123. <li>Defined in src/RcsbFvSequence/SequenceViews/AbstractView.tsx:18</li>
  124. </ul>
  125. </aside>
  126. </section>
  127. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  128. <a name="subtitle" class="tsd-anchor"></a>
  129. <h3><span class="tsd-flag ts-flagOptional">Optional</span> subtitle</h3>
  130. <div class="tsd-signature tsd-kind-icon">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></div>
  131. <aside class="tsd-sources">
  132. <ul>
  133. <li>Defined in src/RcsbFvSequence/SequenceViews/AbstractView.tsx:16</li>
  134. </ul>
  135. </aside>
  136. </section>
  137. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  138. <a name="title" class="tsd-anchor"></a>
  139. <h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
  140. <div class="tsd-signature tsd-kind-icon">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></div>
  141. <aside class="tsd-sources">
  142. <ul>
  143. <li>Defined in src/RcsbFvSequence/SequenceViews/AbstractView.tsx:15</li>
  144. </ul>
  145. </aside>
  146. </section>
  147. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  148. <a name="unmount" class="tsd-anchor"></a>
  149. <h3>unmount</h3>
  150. <div class="tsd-signature tsd-kind-icon">unmount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  151. <aside class="tsd-sources">
  152. <ul>
  153. <li>Defined in src/RcsbFvSequence/SequenceViews/AbstractView.tsx:19</li>
  154. </ul>
  155. </aside>
  156. <div class="tsd-type-declaration">
  157. <h4>Type declaration</h4>
  158. <ul class="tsd-parameters">
  159. <li class="tsd-parameter-signature">
  160. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  161. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  162. </ul>
  163. <ul class="tsd-descriptions">
  164. <li class="tsd-description">
  165. <h4 class="tsd-parameters-title">Parameters</h4>
  166. <ul class="tsd-parameters">
  167. <li>
  168. <h5>flag: <span class="tsd-signature-type">boolean</span></h5>
  169. </li>
  170. </ul>
  171. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  172. </li>
  173. </ul>
  174. </li>
  175. </ul>
  176. </div>
  177. </section>
  178. </section>
  179. </div>
  180. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  181. <nav class="tsd-navigation primary">
  182. <ul>
  183. <li class="globals ">
  184. <a href="../globals.html"><em>Globals</em></a>
  185. </li>
  186. </ul>
  187. </nav>
  188. <nav class="tsd-navigation secondary menu-sticky">
  189. <ul class="before-current">
  190. </ul>
  191. <ul class="current">
  192. <li class="current tsd-kind-interface">
  193. <a href="abstractviewinterface.html" class="tsd-kind-icon">Abstract<wbr>View<wbr>Interface</a>
  194. <ul>
  195. <li class=" tsd-kind-property tsd-parent-kind-interface">
  196. <a href="abstractviewinterface.html#componentid" class="tsd-kind-icon">component<wbr>Id</a>
  197. </li>
  198. <li class=" tsd-kind-property tsd-parent-kind-interface">
  199. <a href="abstractviewinterface.html#plugin" class="tsd-kind-icon">plugin</a>
  200. </li>
  201. <li class=" tsd-kind-property tsd-parent-kind-interface">
  202. <a href="abstractviewinterface.html#selectormanager" class="tsd-kind-icon">selector<wbr>Manager</a>
  203. </li>
  204. <li class=" tsd-kind-property tsd-parent-kind-interface">
  205. <a href="abstractviewinterface.html#subtitle" class="tsd-kind-icon">subtitle</a>
  206. </li>
  207. <li class=" tsd-kind-property tsd-parent-kind-interface">
  208. <a href="abstractviewinterface.html#title" class="tsd-kind-icon">title</a>
  209. </li>
  210. <li class=" tsd-kind-property tsd-parent-kind-interface">
  211. <a href="abstractviewinterface.html#unmount" class="tsd-kind-icon">unmount</a>
  212. </li>
  213. </ul>
  214. </li>
  215. </ul>
  216. <ul class="after-current">
  217. </ul>
  218. </nav>
  219. </div>
  220. </div>
  221. </div>
  222. <footer class="with-border-bottom">
  223. <div class="container">
  224. <h2>Legend</h2>
  225. <div class="tsd-legend-group">
  226. <ul class="tsd-legend">
  227. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  228. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  229. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  230. </ul>
  231. <ul class="tsd-legend">
  232. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  233. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  234. </ul>
  235. <ul class="tsd-legend">
  236. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  237. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  238. </ul>
  239. <ul class="tsd-legend">
  240. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  241. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  242. </ul>
  243. <ul class="tsd-legend">
  244. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  245. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  246. </ul>
  247. </div>
  248. </div>
  249. </footer>
  250. <div class="container tsd-generator">
  251. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  252. </div>
  253. <div class="overlay"></div>
  254. <script src="../assets/js/main.js"></script>
  255. </body>
  256. </html>