blockselectormanager.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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>BlockSelectorManager | @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="blockselectormanager.html">BlockSelectorManager</a>
  60. </li>
  61. </ul>
  62. <h1>Class BlockSelectorManager</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">BlockSelectorManager</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>Constructors</h3>
  83. <ul class="tsd-index-list">
  84. <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="blockselectormanager.html#constructor" class="tsd-kind-icon">constructor</a></li>
  85. </ul>
  86. </section>
  87. <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
  88. <h3>Properties</h3>
  89. <ul class="tsd-index-list">
  90. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="blockselectormanager.html#blockid" class="tsd-kind-icon">block<wbr>Id</a></li>
  91. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="blockselectormanager.html#previousblockid" class="tsd-kind-icon">previous<wbr>Block<wbr>Id</a></li>
  92. </ul>
  93. </section>
  94. <section class="tsd-index-section ">
  95. <h3>Methods</h3>
  96. <ul class="tsd-index-list">
  97. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="blockselectormanager.html#blockchangecallback" class="tsd-kind-icon">block<wbr>Change<wbr>Callback</a></li>
  98. <li class="tsd-kind-method tsd-parent-kind-class"><a href="blockselectormanager.html#getactiveblock" class="tsd-kind-icon">get<wbr>Active<wbr>Block</a></li>
  99. <li class="tsd-kind-method tsd-parent-kind-class"><a href="blockselectormanager.html#getpreviousblock" class="tsd-kind-icon">get<wbr>Previous<wbr>Block</a></li>
  100. <li class="tsd-kind-method tsd-parent-kind-class"><a href="blockselectormanager.html#setactiveblock" class="tsd-kind-icon">set<wbr>Active<wbr>Block</a></li>
  101. </ul>
  102. </section>
  103. </div>
  104. </section>
  105. </section>
  106. <section class="tsd-panel-group tsd-member-group ">
  107. <h2>Constructors</h2>
  108. <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
  109. <a name="constructor" class="tsd-anchor"></a>
  110. <h3>constructor</h3>
  111. <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
  112. <li class="tsd-signature tsd-kind-icon">new <wbr>Block<wbr>Selector<wbr>Manager<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="blockselectormanager.html" class="tsd-signature-type">BlockSelectorManager</a></li>
  113. </ul>
  114. <ul class="tsd-descriptions">
  115. <li class="tsd-description">
  116. <aside class="tsd-sources">
  117. <ul>
  118. <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:47</li>
  119. </ul>
  120. </aside>
  121. <h4 class="tsd-parameters-title">Parameters</h4>
  122. <ul class="tsd-parameters">
  123. <li>
  124. <h5>f: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
  125. <ul class="tsd-parameters">
  126. <li class="tsd-parameter-signature">
  127. <ul class="tsd-signatures tsd-kind-type-literal">
  128. <li class="tsd-signature tsd-kind-icon"><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>
  129. </ul>
  130. <ul class="tsd-descriptions">
  131. <li class="tsd-description">
  132. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  133. </li>
  134. </ul>
  135. </li>
  136. </ul>
  137. </li>
  138. </ul>
  139. <h4 class="tsd-returns-title">Returns <a href="blockselectormanager.html" class="tsd-signature-type">BlockSelectorManager</a></h4>
  140. </li>
  141. </ul>
  142. </section>
  143. </section>
  144. <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
  145. <h2>Properties</h2>
  146. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
  147. <a name="blockid" class="tsd-anchor"></a>
  148. <h3><span class="tsd-flag ts-flagPrivate">Private</span> block<wbr>Id</h3>
  149. <div class="tsd-signature tsd-kind-icon">block<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  150. <aside class="tsd-sources">
  151. <ul>
  152. <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:45</li>
  153. </ul>
  154. </aside>
  155. </section>
  156. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
  157. <a name="previousblockid" class="tsd-anchor"></a>
  158. <h3><span class="tsd-flag ts-flagPrivate">Private</span> previous<wbr>Block<wbr>Id</h3>
  159. <div class="tsd-signature tsd-kind-icon">previous<wbr>Block<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  160. <aside class="tsd-sources">
  161. <ul>
  162. <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:46</li>
  163. </ul>
  164. </aside>
  165. </section>
  166. </section>
  167. <section class="tsd-panel-group tsd-member-group ">
  168. <h2>Methods</h2>
  169. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
  170. <a name="blockchangecallback" class="tsd-anchor"></a>
  171. <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> block<wbr>Change<wbr>Callback</h3>
  172. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
  173. <li class="tsd-signature tsd-kind-icon">block<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>
  174. </ul>
  175. <ul class="tsd-descriptions">
  176. <li class="tsd-description">
  177. <aside class="tsd-sources">
  178. <ul>
  179. <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:47</li>
  180. </ul>
  181. </aside>
  182. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  183. </li>
  184. </ul>
  185. </section>
  186. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  187. <a name="getactiveblock" class="tsd-anchor"></a>
  188. <h3>get<wbr>Active<wbr>Block</h3>
  189. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  190. <li class="tsd-signature tsd-kind-icon">get<wbr>Active<wbr>Block<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
  191. </ul>
  192. <ul class="tsd-descriptions">
  193. <li class="tsd-description">
  194. <aside class="tsd-sources">
  195. <ul>
  196. <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:56</li>
  197. </ul>
  198. </aside>
  199. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
  200. </li>
  201. </ul>
  202. </section>
  203. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  204. <a name="getpreviousblock" class="tsd-anchor"></a>
  205. <h3>get<wbr>Previous<wbr>Block</h3>
  206. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  207. <li class="tsd-signature tsd-kind-icon">get<wbr>Previous<wbr>Block<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
  208. </ul>
  209. <ul class="tsd-descriptions">
  210. <li class="tsd-description">
  211. <aside class="tsd-sources">
  212. <ul>
  213. <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:59</li>
  214. </ul>
  215. </aside>
  216. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
  217. </li>
  218. </ul>
  219. </section>
  220. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  221. <a name="setactiveblock" class="tsd-anchor"></a>
  222. <h3>set<wbr>Active<wbr>Block</h3>
  223. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  224. <li class="tsd-signature tsd-kind-icon">set<wbr>Active<wbr>Block<span class="tsd-signature-symbol">(</span>blockId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  225. </ul>
  226. <ul class="tsd-descriptions">
  227. <li class="tsd-description">
  228. <aside class="tsd-sources">
  229. <ul>
  230. <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:51</li>
  231. </ul>
  232. </aside>
  233. <h4 class="tsd-parameters-title">Parameters</h4>
  234. <ul class="tsd-parameters">
  235. <li>
  236. <h5>blockId: <span class="tsd-signature-type">string</span></h5>
  237. </li>
  238. </ul>
  239. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  240. </li>
  241. </ul>
  242. </section>
  243. </section>
  244. </div>
  245. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  246. <nav class="tsd-navigation primary">
  247. <ul>
  248. <li class="globals ">
  249. <a href="../globals.html"><em>Globals</em></a>
  250. </li>
  251. </ul>
  252. </nav>
  253. <nav class="tsd-navigation secondary menu-sticky">
  254. <ul class="before-current">
  255. </ul>
  256. <ul class="current">
  257. <li class="current tsd-kind-class">
  258. <a href="blockselectormanager.html" class="tsd-kind-icon">Block<wbr>Selector<wbr>Manager</a>
  259. <ul>
  260. <li class=" tsd-kind-constructor tsd-parent-kind-class">
  261. <a href="blockselectormanager.html#constructor" class="tsd-kind-icon">constructor</a>
  262. </li>
  263. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
  264. <a href="blockselectormanager.html#blockid" class="tsd-kind-icon">block<wbr>Id</a>
  265. </li>
  266. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
  267. <a href="blockselectormanager.html#previousblockid" class="tsd-kind-icon">previous<wbr>Block<wbr>Id</a>
  268. </li>
  269. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
  270. <a href="blockselectormanager.html#blockchangecallback" class="tsd-kind-icon">block<wbr>Change<wbr>Callback</a>
  271. </li>
  272. <li class=" tsd-kind-method tsd-parent-kind-class">
  273. <a href="blockselectormanager.html#getactiveblock" class="tsd-kind-icon">get<wbr>Active<wbr>Block</a>
  274. </li>
  275. <li class=" tsd-kind-method tsd-parent-kind-class">
  276. <a href="blockselectormanager.html#getpreviousblock" class="tsd-kind-icon">get<wbr>Previous<wbr>Block</a>
  277. </li>
  278. <li class=" tsd-kind-method tsd-parent-kind-class">
  279. <a href="blockselectormanager.html#setactiveblock" class="tsd-kind-icon">set<wbr>Active<wbr>Block</a>
  280. </li>
  281. </ul>
  282. </li>
  283. </ul>
  284. <ul class="after-current">
  285. </ul>
  286. </nav>
  287. </div>
  288. </div>
  289. </div>
  290. <footer class="with-border-bottom">
  291. <div class="container">
  292. <h2>Legend</h2>
  293. <div class="tsd-legend-group">
  294. <ul class="tsd-legend">
  295. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  296. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  297. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  298. </ul>
  299. <ul class="tsd-legend">
  300. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  301. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  302. </ul>
  303. <ul class="tsd-legend">
  304. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  305. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  306. </ul>
  307. <ul class="tsd-legend">
  308. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  309. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  310. </ul>
  311. <ul class="tsd-legend">
  312. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  313. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  314. </ul>
  315. </div>
  316. </div>
  317. </footer>
  318. <div class="container tsd-generator">
  319. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  320. </div>
  321. <div class="overlay"></div>
  322. <script src="../assets/js/main.js"></script>
  323. </body>
  324. </html>