rcsbfvcontextmanager.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  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>RcsbFvContextManager | @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="rcsbfvcontextmanager.html">RcsbFvContextManager</a>
  60. </li>
  61. </ul>
  62. <h1>Class RcsbFvContextManager</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-comment">
  70. <div class="tsd-comment tsd-typography">
  71. <div class="lead">
  72. <p>rxjs Event Handler Object. It allows objects to subscribe methods and then, get(send) events to(from) other objects</p>
  73. </div>
  74. </div>
  75. </section>
  76. <section class="tsd-panel tsd-hierarchy">
  77. <h3>Hierarchy</h3>
  78. <ul class="tsd-hierarchy">
  79. <li>
  80. <span class="target">RcsbFvContextManager</span>
  81. </li>
  82. </ul>
  83. </section>
  84. <section class="tsd-panel-group tsd-index-group">
  85. <h2>Index</h2>
  86. <section class="tsd-panel tsd-index-panel">
  87. <div class="tsd-index-content">
  88. <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
  89. <h3>Properties</h3>
  90. <ul class="tsd-index-list">
  91. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="rcsbfvcontextmanager.html#subject" class="tsd-kind-icon">subject</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"><a href="rcsbfvcontextmanager.html#next" class="tsd-kind-icon">next</a></li>
  98. <li class="tsd-kind-method tsd-parent-kind-class"><a href="rcsbfvcontextmanager.html#subscribe" class="tsd-kind-icon">subscribe</a></li>
  99. <li class="tsd-kind-method tsd-parent-kind-class"><a href="rcsbfvcontextmanager.html#unsubscribeall" class="tsd-kind-icon">unsubscribe<wbr>All</a></li>
  100. </ul>
  101. </section>
  102. </div>
  103. </section>
  104. </section>
  105. <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
  106. <h2>Properties</h2>
  107. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
  108. <a name="subject" class="tsd-anchor"></a>
  109. <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> subject</h3>
  110. <div class="tsd-signature tsd-kind-icon">subject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-signature-type">RcsbFvContextManagerInterface</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = new Subject&lt;RcsbFvContextManagerInterface&gt;()</span></div>
  111. <aside class="tsd-sources">
  112. <ul>
  113. <li>Defined in src/RcsbFvContextManager/RcsbFvContextManager.ts:25</li>
  114. </ul>
  115. </aside>
  116. </section>
  117. </section>
  118. <section class="tsd-panel-group tsd-member-group ">
  119. <h2>Methods</h2>
  120. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  121. <a name="next" class="tsd-anchor"></a>
  122. <h3>next</h3>
  123. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  124. <li class="tsd-signature tsd-kind-icon">next<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="../interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-signature-type">RcsbFvContextManagerInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  125. </ul>
  126. <ul class="tsd-descriptions">
  127. <li class="tsd-description">
  128. <aside class="tsd-sources">
  129. <ul>
  130. <li>Defined in src/RcsbFvContextManager/RcsbFvContextManager.ts:29</li>
  131. </ul>
  132. </aside>
  133. <div class="tsd-comment tsd-typography">
  134. <div class="lead">
  135. <p>Call other subscribed methods</p>
  136. </div>
  137. </div>
  138. <h4 class="tsd-parameters-title">Parameters</h4>
  139. <ul class="tsd-parameters">
  140. <li>
  141. <h5>obj: <a href="../interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-signature-type">RcsbFvContextManagerInterface</a></h5>
  142. <div class="tsd-comment tsd-typography">
  143. <p>Event Data Structure Interface</p>
  144. </div>
  145. </li>
  146. </ul>
  147. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  148. </li>
  149. </ul>
  150. </section>
  151. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  152. <a name="subscribe" class="tsd-anchor"></a>
  153. <h3>subscribe</h3>
  154. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  155. <li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><a href="../interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-signature-type">RcsbFvContextManagerInterface</a><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><span class="tsd-signature-type">Subscription</span></li>
  156. </ul>
  157. <ul class="tsd-descriptions">
  158. <li class="tsd-description">
  159. <aside class="tsd-sources">
  160. <ul>
  161. <li>Defined in src/RcsbFvContextManager/RcsbFvContextManager.ts:35</li>
  162. </ul>
  163. </aside>
  164. <div class="tsd-comment tsd-typography">
  165. <div class="lead">
  166. <p>Subscribe loadMethod</p>
  167. </div>
  168. </div>
  169. <h4 class="tsd-parameters-title">Parameters</h4>
  170. <ul class="tsd-parameters">
  171. <li>
  172. <h5>f: <span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><a href="../interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-signature-type">RcsbFvContextManagerInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
  173. <ul class="tsd-parameters">
  174. <li class="tsd-parameter-signature">
  175. <ul class="tsd-signatures tsd-kind-type-literal">
  176. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><a href="../interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-signature-type">RcsbFvContextManagerInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  177. </ul>
  178. <ul class="tsd-descriptions">
  179. <li class="tsd-description">
  180. <h4 class="tsd-parameters-title">Parameters</h4>
  181. <ul class="tsd-parameters">
  182. <li>
  183. <h5>x: <a href="../interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-signature-type">RcsbFvContextManagerInterface</a></h5>
  184. </li>
  185. </ul>
  186. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  187. </li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </li>
  192. </ul>
  193. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Subscription</span></h4>
  194. <p>Subscription</p>
  195. </li>
  196. </ul>
  197. </section>
  198. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  199. <a name="unsubscribeall" class="tsd-anchor"></a>
  200. <h3>unsubscribe<wbr>All</h3>
  201. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  202. <li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>All<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>
  203. </ul>
  204. <ul class="tsd-descriptions">
  205. <li class="tsd-description">
  206. <aside class="tsd-sources">
  207. <ul>
  208. <li>Defined in src/RcsbFvContextManager/RcsbFvContextManager.ts:39</li>
  209. </ul>
  210. </aside>
  211. <div class="tsd-comment tsd-typography">
  212. <div class="lead">
  213. <p>Unsubscribe all methods</p>
  214. </div>
  215. </div>
  216. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  217. </li>
  218. </ul>
  219. </section>
  220. </section>
  221. </div>
  222. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  223. <nav class="tsd-navigation primary">
  224. <ul>
  225. <li class="globals ">
  226. <a href="../globals.html"><em>Globals</em></a>
  227. </li>
  228. </ul>
  229. </nav>
  230. <nav class="tsd-navigation secondary menu-sticky">
  231. <ul class="before-current">
  232. </ul>
  233. <ul class="current">
  234. <li class="current tsd-kind-class">
  235. <a href="rcsbfvcontextmanager.html" class="tsd-kind-icon">Rcsb<wbr>FvContext<wbr>Manager</a>
  236. <ul>
  237. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
  238. <a href="rcsbfvcontextmanager.html#subject" class="tsd-kind-icon">subject</a>
  239. </li>
  240. <li class=" tsd-kind-method tsd-parent-kind-class">
  241. <a href="rcsbfvcontextmanager.html#next" class="tsd-kind-icon">next</a>
  242. </li>
  243. <li class=" tsd-kind-method tsd-parent-kind-class">
  244. <a href="rcsbfvcontextmanager.html#subscribe" class="tsd-kind-icon">subscribe</a>
  245. </li>
  246. <li class=" tsd-kind-method tsd-parent-kind-class">
  247. <a href="rcsbfvcontextmanager.html#unsubscribeall" class="tsd-kind-icon">unsubscribe<wbr>All</a>
  248. </li>
  249. </ul>
  250. </li>
  251. </ul>
  252. <ul class="after-current">
  253. </ul>
  254. </nav>
  255. </div>
  256. </div>
  257. </div>
  258. <footer class="with-border-bottom">
  259. <div class="container">
  260. <h2>Legend</h2>
  261. <div class="tsd-legend-group">
  262. <ul class="tsd-legend">
  263. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  264. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  265. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  266. </ul>
  267. <ul class="tsd-legend">
  268. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  269. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  270. </ul>
  271. <ul class="tsd-legend">
  272. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  273. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  274. </ul>
  275. <ul class="tsd-legend">
  276. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  277. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  278. </ul>
  279. <ul class="tsd-legend">
  280. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  281. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  282. </ul>
  283. </div>
  284. </div>
  285. </footer>
  286. <div class="container tsd-generator">
  287. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  288. </div>
  289. <div class="overlay"></div>
  290. <script src="../assets/js/main.js"></script>
  291. </body>
  292. </html>