index.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  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>@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. </ul>
  59. <h1>@rcsb/rcsb-saguaro-3d</h1>
  60. </div>
  61. </div>
  62. </header>
  63. <div class="container container-main">
  64. <div class="row">
  65. <div class="col-8 col-content">
  66. <div class="tsd-panel tsd-typography">
  67. <a href="#rcsb-saguaro-3d" id="rcsb-saguaro-3d" style="color: inherit; text-decoration: none;">
  68. <h1>rcsb-saguaro-3D</h1>
  69. </a>
  70. <p>RCSB Saguaro Web 3D is an open-source library built on the top of the <a href="https://rcsb.github.io/rcsb-saguaro">RCSB Saguaro 1D Feature Viewer</a>
  71. and <a href="https://github.com/rcsb/rcsb-molstar">RCSB Molstar</a> designed to display protein features at the <a href="https://www.rcsb.org">RCSB Web Site</a>. The package collects protein annotations from the
  72. <a href="https://1d-coordinates.rcsb.org">1D Coordinate Server</a> and the main <a href="https://data.rcsb.org">RCSB Data API</a> and generates Protein
  73. Feature Summaries. The package allows access to RCSB Saguaro and Molstar methods to add or change displayed data. </p>
  74. <a href="#node-module-instalation" id="node-module-instalation" style="color: inherit; text-decoration: none;">
  75. <h3>Node Module Instalation</h3>
  76. </a>
  77. <p><code>npm install @rcsb/rcsb-saguaro-3d</code></p>
  78. <a href="#building-amp-running" id="building-amp-running" style="color: inherit; text-decoration: none;">
  79. <h2>Building &amp; Running</h2>
  80. </a>
  81. <a href="#build-app" id="build-app" style="color: inherit; text-decoration: none;">
  82. <h3>Build app</h3>
  83. </a>
  84. <pre><code><span class="hljs-built_in">npm</span> install
  85. <span class="hljs-built_in">npm</span> run buildOnlyApp</code></pre>
  86. <a href="#build-examples" id="build-examples" style="color: inherit; text-decoration: none;">
  87. <h3>Build examples</h3>
  88. </a>
  89. <pre><code>npm <span class="hljs-builtin-name">run</span> buildOnlyExamples</code></pre><p>From the root of the project:</p>
  90. <pre><code>http-server -p PORT-<span class="hljs-built_in">NUMBER</span></code></pre><p>and navigate to <code>localhost:PORT-NUMBER/build/dist/examples/</code></p>
  91. <a href="#main-classes-and-methods" id="main-classes-and-methods" style="color: inherit; text-decoration: none;">
  92. <h3>Main Classes and Methods</h3>
  93. </a>
  94. <p>Class <strong><code>RcsbFv3DAssembly</code></strong> file <code>src/RcsbFv3D/RcsbFv3DAssembly.tsx</code> builds a predefined view for PDB entries. This is the methods used in the RCSB PDB web portal
  95. (ex: <a href="https://www.rcsb.org/3d-sequence/4HHB">4hhb</a>). Soruce code example can be found in <code>src/examples/assembly/index.ts</code>.</p>
  96. <p>Class <strong><code>RcsbFv3DCustom</code></strong> file <code>src/RcsbFv3D/RcsbFv3DCustom.tsx</code> builds a customized view between one or more feature viewers and a single Molstar plugin.</p>
  97. <a href="#cdn-javascript" id="cdn-javascript" style="color: inherit; text-decoration: none;">
  98. <h3>CDN JavaScript</h3>
  99. </a>
  100. <p><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/@rcsb/rcsb-saguaro-app@3.0.0/build/dist/app.js&quot; type=&quot;text/javascript&quot;&gt;&lt;/script&gt;</code></p>
  101. <a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
  102. <h2>Contributing</h2>
  103. </a>
  104. <p>All contributions are welcome. Please, make a pull request or open an issue.</p>
  105. <a href="#license" id="license" style="color: inherit; text-decoration: none;">
  106. <h2>License</h2>
  107. </a>
  108. <p>The MIT License</p>
  109. <pre><code><span class="hljs-attribute">Copyright</span> (c) <span class="hljs-number">2021</span> - now, RCSB PDB and contributors</code></pre><p>Permission is hereby granted, free of charge, to any person obtaining a copy
  110. of this software and associated documentation files (the &quot;Software&quot;), to deal
  111. in the Software without restriction, including without limitation the rights
  112. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  113. copies of the Software, and to permit persons to whom the Software is
  114. furnished to do so, subject to the following conditions:</p>
  115. <p>The above copyright notice and this permission notice shall be included in
  116. all copies or substantial portions of the Software.</p>
  117. <p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  118. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  119. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  120. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  121. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  122. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  123. THE SOFTWARE.</p>
  124. </div>
  125. </div>
  126. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  127. <nav class="tsd-navigation primary">
  128. <ul>
  129. <li class="globals ">
  130. <a href="globals.html"><em>Globals</em></a>
  131. </li>
  132. </ul>
  133. </nav>
  134. <nav class="tsd-navigation secondary menu-sticky">
  135. <ul class="before-current">
  136. <li class=" tsd-kind-enum">
  137. <a href="enums/eventtype.html" class="tsd-kind-icon">Event<wbr>Type</a>
  138. </li>
  139. <li class=" tsd-kind-enum">
  140. <a href="enums/loadmethod.html" class="tsd-kind-icon">Load<wbr>Method</a>
  141. </li>
  142. <li class=" tsd-kind-enum">
  143. <a href="enums/rcsbfvdomconstants.html" class="tsd-kind-icon">Rcsb<wbr>FvDOMConstants</a>
  144. </li>
  145. <li class=" tsd-kind-class">
  146. <a href="classes/abstractplugin.html" class="tsd-kind-icon">Abstract<wbr>Plugin</a>
  147. </li>
  148. <li class=" tsd-kind-class tsd-has-type-parameter">
  149. <a href="classes/abstractview.html" class="tsd-kind-icon">Abstract<wbr>View</a>
  150. </li>
  151. <li class=" tsd-kind-class tsd-has-type-parameter">
  152. <a href="classes/assemblyview.html" class="tsd-kind-icon">Assembly<wbr>View</a>
  153. </li>
  154. <li class=" tsd-kind-class">
  155. <a href="classes/blockselectormanager.html" class="tsd-kind-icon">Block<wbr>Selector<wbr>Manager</a>
  156. </li>
  157. <li class=" tsd-kind-class tsd-has-type-parameter">
  158. <a href="classes/chaindisplay.html" class="tsd-kind-icon">Chain<wbr>Display</a>
  159. </li>
  160. <li class=" tsd-kind-class tsd-has-type-parameter">
  161. <a href="classes/customview.html" class="tsd-kind-icon">Custom<wbr>View</a>
  162. </li>
  163. <li class=" tsd-kind-class">
  164. <a href="classes/molstarplugin.html" class="tsd-kind-icon">Molstar<wbr>Plugin</a>
  165. </li>
  166. <li class=" tsd-kind-class">
  167. <a href="classes/rcsbfv3dabstract.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DAbstract</a>
  168. </li>
  169. <li class=" tsd-kind-class">
  170. <a href="classes/rcsbfv3dassembly.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DAssembly</a>
  171. </li>
  172. <li class=" tsd-kind-class tsd-has-type-parameter">
  173. <a href="classes/rcsbfv3dcomponent.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DComponent</a>
  174. </li>
  175. <li class=" tsd-kind-class">
  176. <a href="classes/rcsbfv3dcustom.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DCustom</a>
  177. </li>
  178. <li class=" tsd-kind-class">
  179. <a href="classes/rcsbfvcontextmanager.html" class="tsd-kind-icon">Rcsb<wbr>FvContext<wbr>Manager</a>
  180. </li>
  181. <li class=" tsd-kind-class">
  182. <a href="classes/rcsbfvselectormanager.html" class="tsd-kind-icon">Rcsb<wbr>FvSelector<wbr>Manager</a>
  183. </li>
  184. <li class=" tsd-kind-class tsd-has-type-parameter">
  185. <a href="classes/rcsbfvsequence.html" class="tsd-kind-icon">Rcsb<wbr>FvSequence</a>
  186. </li>
  187. <li class=" tsd-kind-class tsd-has-type-parameter">
  188. <a href="classes/rcsbfvstructure.html" class="tsd-kind-icon">Rcsb<wbr>FvStructure</a>
  189. </li>
  190. <li class=" tsd-kind-interface">
  191. <a href="interfaces/abstractviewinterface.html" class="tsd-kind-icon">Abstract<wbr>View<wbr>Interface</a>
  192. </li>
  193. <li class=" tsd-kind-interface">
  194. <a href="interfaces/assemblyviewinterface.html" class="tsd-kind-icon">Assembly<wbr>View<wbr>Interface</a>
  195. </li>
  196. <li class=" tsd-kind-interface">
  197. <a href="interfaces/callbackconfig.html" class="tsd-kind-icon">Callback<wbr>Config</a>
  198. </li>
  199. <li class=" tsd-kind-interface">
  200. <a href="interfaces/chaindisplayinterface.html" class="tsd-kind-icon">Chain<wbr>Display<wbr>Interface</a>
  201. </li>
  202. <li class=" tsd-kind-interface">
  203. <a href="interfaces/chaindisplaystate.html" class="tsd-kind-icon">Chain<wbr>Display<wbr>State</a>
  204. </li>
  205. <li class=" tsd-kind-interface">
  206. <a href="interfaces/chainselectioninterface.html" class="tsd-kind-icon">Chain<wbr>Selection<wbr>Interface</a>
  207. </li>
  208. <li class=" tsd-kind-interface">
  209. <a href="interfaces/customviewinterface.html" class="tsd-kind-icon">Custom<wbr>View<wbr>Interface</a>
  210. </li>
  211. <li class=" tsd-kind-interface">
  212. <a href="interfaces/featureblockinterface.html" class="tsd-kind-icon">Feature<wbr>Block<wbr>Interface</a>
  213. </li>
  214. <li class=" tsd-kind-interface">
  215. <a href="interfaces/featureviewinterface.html" class="tsd-kind-icon">Feature<wbr>View<wbr>Interface</a>
  216. </li>
  217. <li class=" tsd-kind-interface">
  218. <a href="interfaces/loadmolstarinterface.html" class="tsd-kind-icon">Load<wbr>Molstar<wbr>Interface</a>
  219. </li>
  220. <li class=" tsd-kind-interface tsd-has-type-parameter">
  221. <a href="interfaces/loadparams.html" class="tsd-kind-icon">Load<wbr>Params</a>
  222. </li>
  223. <li class=" tsd-kind-interface">
  224. <a href="interfaces/rcsbfv3dabstractinterface.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DAbstract<wbr>Interface</a>
  225. </li>
  226. <li class=" tsd-kind-interface">
  227. <a href="interfaces/rcsbfv3dassemblyinterface.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DAssembly<wbr>Interface</a>
  228. </li>
  229. <li class=" tsd-kind-interface">
  230. <a href="interfaces/rcsbfv3dcomponentinterface.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DComponent<wbr>Interface</a>
  231. </li>
  232. <li class=" tsd-kind-interface">
  233. <a href="interfaces/rcsbfv3dcomponentstate.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DComponent<wbr>State</a>
  234. </li>
  235. <li class=" tsd-kind-interface">
  236. <a href="interfaces/rcsbfv3dcssconfig.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DCss<wbr>Config</a>
  237. </li>
  238. <li class=" tsd-kind-interface">
  239. <a href="interfaces/rcsbfv3dcustominterface.html" class="tsd-kind-icon">Rcsb<wbr>Fv3DCustom<wbr>Interface</a>
  240. </li>
  241. <li class=" tsd-kind-interface">
  242. <a href="interfaces/rcsbfvcontextmanagerinterface.html" class="tsd-kind-icon">Rcsb<wbr>FvContext<wbr>Manager<wbr>Interface</a>
  243. </li>
  244. <li class=" tsd-kind-interface">
  245. <a href="interfaces/rcsbfvsequenceinterface.html" class="tsd-kind-icon">Rcsb<wbr>FvSequence<wbr>Interface</a>
  246. </li>
  247. <li class=" tsd-kind-interface">
  248. <a href="interfaces/rcsbfvstructureinterface.html" class="tsd-kind-icon">Rcsb<wbr>FvStructure<wbr>Interface</a>
  249. </li>
  250. <li class=" tsd-kind-interface">
  251. <a href="interfaces/regionselectioninterface.html" class="tsd-kind-icon">Region<wbr>Selection<wbr>Interface</a>
  252. </li>
  253. <li class=" tsd-kind-interface">
  254. <a href="interfaces/residueselectioninterface.html" class="tsd-kind-icon">Residue<wbr>Selection<wbr>Interface</a>
  255. </li>
  256. <li class=" tsd-kind-interface">
  257. <a href="interfaces/saguaroplugininterface.html" class="tsd-kind-icon">Saguaro<wbr>Plugin<wbr>Interface</a>
  258. </li>
  259. <li class=" tsd-kind-interface">
  260. <a href="interfaces/saguaropluginpublicinterface.html" class="tsd-kind-icon">Saguaro<wbr>Plugin<wbr>Public<wbr>Interface</a>
  261. </li>
  262. <li class=" tsd-kind-interface">
  263. <a href="interfaces/sequenceviewinterface.html" class="tsd-kind-icon">Sequence<wbr>View<wbr>Interface</a>
  264. </li>
  265. <li class=" tsd-kind-interface">
  266. <a href="interfaces/updateconfiginterface.html" class="tsd-kind-icon">Update<wbr>Config<wbr>Interface</a>
  267. </li>
  268. <li class=" tsd-kind-type-alias">
  269. <a href="globals.html#chaintype" class="tsd-kind-icon">Chain<wbr>Type</a>
  270. </li>
  271. <li class=" tsd-kind-type-alias">
  272. <a href="globals.html#customviewstateinterface" class="tsd-kind-icon">Custom<wbr>View<wbr>State<wbr>Interface</a>
  273. </li>
  274. <li class=" tsd-kind-type-alias">
  275. <a href="globals.html#saguaropluginmodelmaptype" class="tsd-kind-icon">Saguaro<wbr>Plugin<wbr>Model<wbr>Map<wbr>Type</a>
  276. </li>
  277. <li class=" tsd-kind-type-alias">
  278. <a href="globals.html#structureobject" class="tsd-kind-icon">Structure<wbr>Object</a>
  279. </li>
  280. <li class=" tsd-kind-variable">
  281. <a href="globals.html#rcsbrepresentationpreset" class="tsd-kind-icon">Rcsb<wbr>Representation<wbr>Preset</a>
  282. </li>
  283. <li class=" tsd-kind-variable">
  284. <a href="globals.html#rcsbfvwebapppath" class="tsd-kind-icon">rcsb<wbr>FvWeb<wbr>App<wbr>Path</a>
  285. </li>
  286. <li class=" tsd-kind-function">
  287. <a href="globals.html#buildintervals" class="tsd-kind-icon">build<wbr>Intervals</a>
  288. </li>
  289. <li class=" tsd-kind-function">
  290. <a href="globals.html#createcomponents" class="tsd-kind-icon">create<wbr>Components</a>
  291. </li>
  292. <li class=" tsd-kind-function">
  293. <a href="globals.html#getchainvalues" class="tsd-kind-icon">get<wbr>Chain<wbr>Values</a>
  294. </li>
  295. <li class=" tsd-kind-function">
  296. <a href="globals.html#getmodelentityoptions" class="tsd-kind-icon">get<wbr>Model<wbr>Entity<wbr>Options</a>
  297. </li>
  298. <li class=" tsd-kind-function">
  299. <a href="globals.html#getstructure" class="tsd-kind-icon">get<wbr>Structure</a>
  300. </li>
  301. <li class=" tsd-kind-function">
  302. <a href="globals.html#getstructureoptions" class="tsd-kind-icon">get<wbr>Structure<wbr>Options</a>
  303. </li>
  304. <li class=" tsd-kind-function">
  305. <a href="globals.html#getstructurewithmodelid" class="tsd-kind-icon">get<wbr>Structure<wbr>With<wbr>Model<wbr>Id</a>
  306. </li>
  307. <li class=" tsd-kind-function">
  308. <a href="globals.html#processgaps" class="tsd-kind-icon">process<wbr>Gaps</a>
  309. </li>
  310. <li class=" tsd-kind-function">
  311. <a href="globals.html#processmultiplegaps" class="tsd-kind-icon">process<wbr>Multiple<wbr>Gaps</a>
  312. </li>
  313. <li class=" tsd-kind-function">
  314. <a href="globals.html#selectionfilter" class="tsd-kind-icon">selection<wbr>Filter</a>
  315. </li>
  316. <li class=" tsd-kind-function">
  317. <a href="globals.html#selectionfromresidueselection" class="tsd-kind-icon">selection<wbr>From<wbr>Residue<wbr>Selection</a>
  318. </li>
  319. <li class=" tsd-kind-function">
  320. <a href="globals.html#splitmodelentityid" class="tsd-kind-icon">split<wbr>Model<wbr>Entity<wbr>Id</a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </div>
  325. </div>
  326. </div>
  327. <footer class="with-border-bottom">
  328. <div class="container">
  329. <h2>Legend</h2>
  330. <div class="tsd-legend-group">
  331. <ul class="tsd-legend">
  332. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  333. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  334. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  335. </ul>
  336. <ul class="tsd-legend">
  337. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  338. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  339. </ul>
  340. <ul class="tsd-legend">
  341. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  342. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  343. </ul>
  344. <ul class="tsd-legend">
  345. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  346. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  347. </ul>
  348. <ul class="tsd-legend">
  349. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  350. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  351. </ul>
  352. </div>
  353. </div>
  354. </footer>
  355. <div class="container tsd-generator">
  356. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  357. </div>
  358. <div class="overlay"></div>
  359. <script src="assets/js/main.js"></script>
  360. </body>
  361. </html>