sequenceviewinterface.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  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>SequenceViewInterface | @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="sequenceviewinterface.html">SequenceViewInterface</a>
  60. </li>
  61. </ul>
  62. <h1>Interface SequenceViewInterface</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">SequenceViewInterface</span>
  74. </li>
  75. </ul>
  76. </section>
  77. <section class="tsd-panel">
  78. <h3>Implemented by</h3>
  79. <ul class="tsd-hierarchy">
  80. <li><a href="../classes/abstractview.html" class="tsd-signature-type">AbstractView</a></li>
  81. <li><a href="../classes/assemblyview.html" class="tsd-signature-type">AssemblyView</a></li>
  82. <li><a href="../classes/customview.html" class="tsd-signature-type">CustomView</a></li>
  83. </ul>
  84. </section>
  85. <section class="tsd-panel-group tsd-index-group">
  86. <h2>Index</h2>
  87. <section class="tsd-panel tsd-index-panel">
  88. <div class="tsd-index-content">
  89. <section class="tsd-index-section ">
  90. <h3>Methods</h3>
  91. <ul class="tsd-index-list">
  92. <li class="tsd-kind-method tsd-parent-kind-interface"><a href="sequenceviewinterface.html#additionalcontent" class="tsd-kind-icon">additional<wbr>Content</a></li>
  93. <li class="tsd-kind-method tsd-parent-kind-interface"><a href="sequenceviewinterface.html#modelchangecallback" class="tsd-kind-icon">model<wbr>Change<wbr>Callback</a></li>
  94. <li class="tsd-kind-method tsd-parent-kind-interface"><a href="sequenceviewinterface.html#representationchangecallback" class="tsd-kind-icon">representation<wbr>Change<wbr>Callback</a></li>
  95. <li class="tsd-kind-method tsd-parent-kind-interface"><a href="sequenceviewinterface.html#structurehovercallback" class="tsd-kind-icon">structure<wbr>Hover<wbr>Callback</a></li>
  96. <li class="tsd-kind-method tsd-parent-kind-interface"><a href="sequenceviewinterface.html#structureselectioncallback" class="tsd-kind-icon">structure<wbr>Selection<wbr>Callback</a></li>
  97. <li class="tsd-kind-method tsd-parent-kind-interface"><a href="sequenceviewinterface.html#updatedimensions" class="tsd-kind-icon">update<wbr>Dimensions</a></li>
  98. </ul>
  99. </section>
  100. </div>
  101. </section>
  102. </section>
  103. <section class="tsd-panel-group tsd-member-group ">
  104. <h2>Methods</h2>
  105. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
  106. <a name="additionalcontent" class="tsd-anchor"></a>
  107. <h3>additional<wbr>Content</h3>
  108. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
  109. <li class="tsd-signature tsd-kind-icon">additional<wbr>Content<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
  110. </ul>
  111. <ul class="tsd-descriptions">
  112. <li class="tsd-description">
  113. <aside class="tsd-sources">
  114. <ul>
  115. <li>Defined in src/RcsbFvSequence/SequenceViews/SequenceViewInterface.ts:9</li>
  116. </ul>
  117. </aside>
  118. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4>
  119. </li>
  120. </ul>
  121. </section>
  122. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
  123. <a name="modelchangecallback" class="tsd-anchor"></a>
  124. <h3>model<wbr>Change<wbr>Callback</h3>
  125. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
  126. <li class="tsd-signature tsd-kind-icon">model<wbr>Change<wbr>Callback<span class="tsd-signature-symbol">(</span>modelMap<span class="tsd-signature-symbol">: </span><a href="../globals.html#saguaropluginmodelmaptype" class="tsd-signature-type">SaguaroPluginModelMapType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  127. </ul>
  128. <ul class="tsd-descriptions">
  129. <li class="tsd-description">
  130. <aside class="tsd-sources">
  131. <ul>
  132. <li>Defined in src/RcsbFvSequence/SequenceViews/SequenceViewInterface.ts:7</li>
  133. </ul>
  134. </aside>
  135. <h4 class="tsd-parameters-title">Parameters</h4>
  136. <ul class="tsd-parameters">
  137. <li>
  138. <h5>modelMap: <a href="../globals.html#saguaropluginmodelmaptype" class="tsd-signature-type">SaguaroPluginModelMapType</a></h5>
  139. </li>
  140. </ul>
  141. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  142. </li>
  143. </ul>
  144. </section>
  145. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
  146. <a name="representationchangecallback" class="tsd-anchor"></a>
  147. <h3>representation<wbr>Change<wbr>Callback</h3>
  148. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
  149. <li class="tsd-signature tsd-kind-icon">representation<wbr>Change<wbr>Callback<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  150. </ul>
  151. <ul class="tsd-descriptions">
  152. <li class="tsd-description">
  153. <aside class="tsd-sources">
  154. <ul>
  155. <li>Defined in src/RcsbFvSequence/SequenceViews/SequenceViewInterface.ts:6</li>
  156. </ul>
  157. </aside>
  158. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  159. </li>
  160. </ul>
  161. </section>
  162. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
  163. <a name="structurehovercallback" class="tsd-anchor"></a>
  164. <h3>structure<wbr>Hover<wbr>Callback</h3>
  165. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
  166. <li class="tsd-signature tsd-kind-icon">structure<wbr>Hover<wbr>Callback<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  167. </ul>
  168. <ul class="tsd-descriptions">
  169. <li class="tsd-description">
  170. <aside class="tsd-sources">
  171. <ul>
  172. <li>Defined in src/RcsbFvSequence/SequenceViews/SequenceViewInterface.ts:5</li>
  173. </ul>
  174. </aside>
  175. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  176. </li>
  177. </ul>
  178. </section>
  179. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
  180. <a name="structureselectioncallback" class="tsd-anchor"></a>
  181. <h3>structure<wbr>Selection<wbr>Callback</h3>
  182. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
  183. <li class="tsd-signature tsd-kind-icon">structure<wbr>Selection<wbr>Callback<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  184. </ul>
  185. <ul class="tsd-descriptions">
  186. <li class="tsd-description">
  187. <aside class="tsd-sources">
  188. <ul>
  189. <li>Defined in src/RcsbFvSequence/SequenceViews/SequenceViewInterface.ts:4</li>
  190. </ul>
  191. </aside>
  192. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  193. </li>
  194. </ul>
  195. </section>
  196. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
  197. <a name="updatedimensions" class="tsd-anchor"></a>
  198. <h3>update<wbr>Dimensions</h3>
  199. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
  200. <li class="tsd-signature tsd-kind-icon">update<wbr>Dimensions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  201. </ul>
  202. <ul class="tsd-descriptions">
  203. <li class="tsd-description">
  204. <aside class="tsd-sources">
  205. <ul>
  206. <li>Defined in src/RcsbFvSequence/SequenceViews/SequenceViewInterface.ts:8</li>
  207. </ul>
  208. </aside>
  209. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  210. </li>
  211. </ul>
  212. </section>
  213. </section>
  214. </div>
  215. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  216. <nav class="tsd-navigation primary">
  217. <ul>
  218. <li class="globals ">
  219. <a href="../globals.html"><em>Globals</em></a>
  220. </li>
  221. </ul>
  222. </nav>
  223. <nav class="tsd-navigation secondary menu-sticky">
  224. <ul class="before-current">
  225. </ul>
  226. <ul class="current">
  227. <li class="current tsd-kind-interface">
  228. <a href="sequenceviewinterface.html" class="tsd-kind-icon">Sequence<wbr>View<wbr>Interface</a>
  229. <ul>
  230. <li class=" tsd-kind-method tsd-parent-kind-interface">
  231. <a href="sequenceviewinterface.html#additionalcontent" class="tsd-kind-icon">additional<wbr>Content</a>
  232. </li>
  233. <li class=" tsd-kind-method tsd-parent-kind-interface">
  234. <a href="sequenceviewinterface.html#modelchangecallback" class="tsd-kind-icon">model<wbr>Change<wbr>Callback</a>
  235. </li>
  236. <li class=" tsd-kind-method tsd-parent-kind-interface">
  237. <a href="sequenceviewinterface.html#representationchangecallback" class="tsd-kind-icon">representation<wbr>Change<wbr>Callback</a>
  238. </li>
  239. <li class=" tsd-kind-method tsd-parent-kind-interface">
  240. <a href="sequenceviewinterface.html#structurehovercallback" class="tsd-kind-icon">structure<wbr>Hover<wbr>Callback</a>
  241. </li>
  242. <li class=" tsd-kind-method tsd-parent-kind-interface">
  243. <a href="sequenceviewinterface.html#structureselectioncallback" class="tsd-kind-icon">structure<wbr>Selection<wbr>Callback</a>
  244. </li>
  245. <li class=" tsd-kind-method tsd-parent-kind-interface">
  246. <a href="sequenceviewinterface.html#updatedimensions" class="tsd-kind-icon">update<wbr>Dimensions</a>
  247. </li>
  248. </ul>
  249. </li>
  250. </ul>
  251. <ul class="after-current">
  252. </ul>
  253. </nav>
  254. </div>
  255. </div>
  256. </div>
  257. <footer class="with-border-bottom">
  258. <div class="container">
  259. <h2>Legend</h2>
  260. <div class="tsd-legend-group">
  261. <ul class="tsd-legend">
  262. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  263. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  264. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  265. </ul>
  266. <ul class="tsd-legend">
  267. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  268. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  269. </ul>
  270. <ul class="tsd-legend">
  271. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  272. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  273. </ul>
  274. <ul class="tsd-legend">
  275. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  276. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  277. </ul>
  278. <ul class="tsd-legend">
  279. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  280. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  281. </ul>
  282. </div>
  283. </div>
  284. </footer>
  285. <div class="container tsd-generator">
  286. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  287. </div>
  288. <div class="overlay"></div>
  289. <script src="../assets/js/main.js"></script>
  290. </body>
  291. </html>