saguaroplugininterface.html 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138
  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>SaguaroPluginInterface | @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="saguaroplugininterface.html">SaguaroPluginInterface</a>
  60. </li>
  61. </ul>
  62. <h1>Interface SaguaroPluginInterface</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. <a href="saguaropluginpublicinterface.html" class="tsd-signature-type">SaguaroPluginPublicInterface</a>
  74. <ul class="tsd-hierarchy">
  75. <li>
  76. <span class="target">SaguaroPluginInterface</span>
  77. </li>
  78. </ul>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="tsd-panel">
  83. <h3>Implemented by</h3>
  84. <ul class="tsd-hierarchy">
  85. <li><a href="../classes/molstarplugin.html" class="tsd-signature-type">MolstarPlugin</a></li>
  86. </ul>
  87. </section>
  88. <section class="tsd-panel-group tsd-index-group">
  89. <h2>Index</h2>
  90. <section class="tsd-panel tsd-index-panel">
  91. <div class="tsd-index-content">
  92. <section class="tsd-index-section ">
  93. <h3>Properties</h3>
  94. <ul class="tsd-index-list">
  95. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#clear" class="tsd-kind-icon">clear</a></li>
  96. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#clearselection" class="tsd-kind-icon">clear<wbr>Selection</a></li>
  97. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#getcomponentset" class="tsd-kind-icon">get<wbr>Component<wbr>Set</a></li>
  98. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#init" class="tsd-kind-icon">init</a></li>
  99. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#iscomponent" class="tsd-kind-icon">is<wbr>Component</a></li>
  100. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#load" class="tsd-kind-icon">load</a></li>
  101. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#plugincall" class="tsd-kind-icon">plugin<wbr>Call</a></li>
  102. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#removecomponent" class="tsd-kind-icon">remove<wbr>Component</a></li>
  103. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#resetcamera" class="tsd-kind-icon">reset<wbr>Camera</a></li>
  104. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#sethovercallback" class="tsd-kind-icon">set<wbr>Hover<wbr>Callback</a></li>
  105. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#setmodelchangecallback" class="tsd-kind-icon">set<wbr>Model<wbr>Change<wbr>Callback</a></li>
  106. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#setrepresentationchangecallback" class="tsd-kind-icon">set<wbr>Representation<wbr>Change<wbr>Callback</a></li>
  107. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#setselectcallback" class="tsd-kind-icon">set<wbr>Select<wbr>Callback</a></li>
  108. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="saguaroplugininterface.html#unsetcallbacks" class="tsd-kind-icon">unset<wbr>Callbacks</a></li>
  109. </ul>
  110. </section>
  111. <section class="tsd-index-section tsd-is-inherited">
  112. <h3>Methods</h3>
  113. <ul class="tsd-index-list">
  114. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#camerafocus" class="tsd-kind-icon">camera<wbr>Focus</a></li>
  115. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#clearfocus" class="tsd-kind-icon">clear<wbr>Focus</a></li>
  116. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#colorcomponent" class="tsd-kind-icon">color<wbr>Component</a></li>
  117. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#createcomponent" class="tsd-kind-icon">create<wbr>Component</a></li>
  118. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#displaycomponent" class="tsd-kind-icon">display<wbr>Component</a></li>
  119. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#select" class="tsd-kind-icon">select</a></li>
  120. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="saguaroplugininterface.html#setfocus" class="tsd-kind-icon">set<wbr>Focus</a></li>
  121. </ul>
  122. </section>
  123. </div>
  124. </section>
  125. </section>
  126. <section class="tsd-panel-group tsd-member-group ">
  127. <h2>Properties</h2>
  128. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  129. <a name="clear" class="tsd-anchor"></a>
  130. <h3>clear</h3>
  131. <div class="tsd-signature tsd-kind-icon">clear<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></div>
  132. <aside class="tsd-sources">
  133. <ul>
  134. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:12</li>
  135. </ul>
  136. </aside>
  137. <div class="tsd-type-declaration">
  138. <h4>Type declaration</h4>
  139. <ul class="tsd-parameters">
  140. <li class="tsd-parameter-signature">
  141. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  142. <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>
  143. </ul>
  144. <ul class="tsd-descriptions">
  145. <li class="tsd-description">
  146. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  147. </li>
  148. </ul>
  149. </li>
  150. </ul>
  151. </div>
  152. </section>
  153. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  154. <a name="clearselection" class="tsd-anchor"></a>
  155. <h3>clear<wbr>Selection</h3>
  156. <div class="tsd-signature tsd-kind-icon">clear<wbr>Selection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span>, option<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modelId<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-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  157. <aside class="tsd-sources">
  158. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#clearselection">clearSelection</a></p>
  159. <ul>
  160. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:24</li>
  161. </ul>
  162. </aside>
  163. <div class="tsd-type-declaration">
  164. <h4>Type declaration</h4>
  165. <ul class="tsd-parameters">
  166. <li class="tsd-parameter-signature">
  167. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  168. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span>, option<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modelId<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-symbol">: </span><span class="tsd-signature-type">void</span></li>
  169. </ul>
  170. <ul class="tsd-descriptions">
  171. <li class="tsd-description">
  172. <h4 class="tsd-parameters-title">Parameters</h4>
  173. <ul class="tsd-parameters">
  174. <li>
  175. <h5>mode: <span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span></h5>
  176. </li>
  177. <li>
  178. <h5><span class="tsd-flag ts-flagOptional">Optional</span> option: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
  179. </li>
  180. </ul>
  181. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </div>
  187. </section>
  188. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  189. <a name="getcomponentset" class="tsd-anchor"></a>
  190. <h3>get<wbr>Component<wbr>Set</h3>
  191. <div class="tsd-signature tsd-kind-icon">get<wbr>Component<wbr>Set<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">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
  192. <aside class="tsd-sources">
  193. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#getcomponentset">getComponentSet</a></p>
  194. <ul>
  195. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:34</li>
  196. </ul>
  197. </aside>
  198. <div class="tsd-type-declaration">
  199. <h4>Type declaration</h4>
  200. <ul class="tsd-parameters">
  201. <li class="tsd-parameter-signature">
  202. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  203. <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">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
  204. </ul>
  205. <ul class="tsd-descriptions">
  206. <li class="tsd-description">
  207. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
  208. </li>
  209. </ul>
  210. </li>
  211. </ul>
  212. </div>
  213. </section>
  214. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  215. <a name="init" class="tsd-anchor"></a>
  216. <h3>init</h3>
  217. <div class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>elementId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, props<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  218. <aside class="tsd-sources">
  219. <ul>
  220. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:9</li>
  221. </ul>
  222. </aside>
  223. <div class="tsd-type-declaration">
  224. <h4>Type declaration</h4>
  225. <ul class="tsd-parameters">
  226. <li class="tsd-parameter-signature">
  227. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  228. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>elementId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, props<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  229. </ul>
  230. <ul class="tsd-descriptions">
  231. <li class="tsd-description">
  232. <h4 class="tsd-parameters-title">Parameters</h4>
  233. <ul class="tsd-parameters">
  234. <li>
  235. <h5>elementId: <span class="tsd-signature-type">string</span></h5>
  236. </li>
  237. <li>
  238. <h5><span class="tsd-flag ts-flagOptional">Optional</span> props: <span class="tsd-signature-type">any</span></h5>
  239. </li>
  240. </ul>
  241. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  242. </li>
  243. </ul>
  244. </li>
  245. </ul>
  246. </div>
  247. </section>
  248. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  249. <a name="iscomponent" class="tsd-anchor"></a>
  250. <h3>is<wbr>Component</h3>
  251. <div class="tsd-signature tsd-kind-icon">is<wbr>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>componentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div>
  252. <aside class="tsd-sources">
  253. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#iscomponent">isComponent</a></p>
  254. <ul>
  255. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:31</li>
  256. </ul>
  257. </aside>
  258. <div class="tsd-type-declaration">
  259. <h4>Type declaration</h4>
  260. <ul class="tsd-parameters">
  261. <li class="tsd-parameter-signature">
  262. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  263. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>componentId<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">boolean</span></li>
  264. </ul>
  265. <ul class="tsd-descriptions">
  266. <li class="tsd-description">
  267. <h4 class="tsd-parameters-title">Parameters</h4>
  268. <ul class="tsd-parameters">
  269. <li>
  270. <h5>componentId: <span class="tsd-signature-type">string</span></h5>
  271. </li>
  272. </ul>
  273. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  274. </li>
  275. </ul>
  276. </li>
  277. </ul>
  278. </div>
  279. </section>
  280. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  281. <a name="load" class="tsd-anchor"></a>
  282. <h3>load</h3>
  283. <div class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="loadmolstarinterface.html" class="tsd-signature-type">LoadMolstarInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  284. <aside class="tsd-sources">
  285. <ul>
  286. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:10</li>
  287. </ul>
  288. </aside>
  289. <div class="tsd-type-declaration">
  290. <h4>Type declaration</h4>
  291. <ul class="tsd-parameters">
  292. <li class="tsd-parameter-signature">
  293. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  294. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="loadmolstarinterface.html" class="tsd-signature-type">LoadMolstarInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  295. </ul>
  296. <ul class="tsd-descriptions">
  297. <li class="tsd-description">
  298. <h4 class="tsd-parameters-title">Parameters</h4>
  299. <ul class="tsd-parameters">
  300. <li>
  301. <h5>args: <a href="loadmolstarinterface.html" class="tsd-signature-type">LoadMolstarInterface</a></h5>
  302. </li>
  303. </ul>
  304. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </div>
  310. </section>
  311. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  312. <a name="plugincall" class="tsd-anchor"></a>
  313. <h3>plugin<wbr>Call</h3>
  314. <div class="tsd-signature tsd-kind-icon">plugin<wbr>Call<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>plugin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PluginContext</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"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  315. <aside class="tsd-sources">
  316. <ul>
  317. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:11</li>
  318. </ul>
  319. </aside>
  320. <div class="tsd-type-declaration">
  321. <h4>Type declaration</h4>
  322. <ul class="tsd-parameters">
  323. <li class="tsd-parameter-signature">
  324. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  325. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>plugin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PluginContext</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><span class="tsd-signature-type">void</span></li>
  326. </ul>
  327. <ul class="tsd-descriptions">
  328. <li class="tsd-description">
  329. <h4 class="tsd-parameters-title">Parameters</h4>
  330. <ul class="tsd-parameters">
  331. <li>
  332. <h5>f: <span class="tsd-signature-symbol">(</span>plugin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PluginContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
  333. <ul class="tsd-parameters">
  334. <li class="tsd-parameter-signature">
  335. <ul class="tsd-signatures tsd-kind-type-literal">
  336. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>plugin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PluginContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  337. </ul>
  338. <ul class="tsd-descriptions">
  339. <li class="tsd-description">
  340. <h4 class="tsd-parameters-title">Parameters</h4>
  341. <ul class="tsd-parameters">
  342. <li>
  343. <h5>plugin: <span class="tsd-signature-type">PluginContext</span></h5>
  344. </li>
  345. </ul>
  346. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  347. </li>
  348. </ul>
  349. </li>
  350. </ul>
  351. </li>
  352. </ul>
  353. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  354. </li>
  355. </ul>
  356. </li>
  357. </ul>
  358. </div>
  359. </section>
  360. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  361. <a name="removecomponent" class="tsd-anchor"></a>
  362. <h3>remove<wbr>Component</h3>
  363. <div class="tsd-signature tsd-kind-icon">remove<wbr>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>componentId<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  364. <aside class="tsd-sources">
  365. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#removecomponent">removeComponent</a></p>
  366. <ul>
  367. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:30</li>
  368. </ul>
  369. </aside>
  370. <div class="tsd-type-declaration">
  371. <h4>Type declaration</h4>
  372. <ul class="tsd-parameters">
  373. <li class="tsd-parameter-signature">
  374. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  375. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>componentId<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  376. </ul>
  377. <ul class="tsd-descriptions">
  378. <li class="tsd-description">
  379. <h4 class="tsd-parameters-title">Parameters</h4>
  380. <ul class="tsd-parameters">
  381. <li>
  382. <h5><span class="tsd-flag ts-flagOptional">Optional</span> componentId: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
  383. </li>
  384. </ul>
  385. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  386. </li>
  387. </ul>
  388. </li>
  389. </ul>
  390. </div>
  391. </section>
  392. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  393. <a name="resetcamera" class="tsd-anchor"></a>
  394. <h3>reset<wbr>Camera</h3>
  395. <div class="tsd-signature tsd-kind-icon">reset<wbr>Camera<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></div>
  396. <aside class="tsd-sources">
  397. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#resetcamera">resetCamera</a></p>
  398. <ul>
  399. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:39</li>
  400. </ul>
  401. </aside>
  402. <div class="tsd-type-declaration">
  403. <h4>Type declaration</h4>
  404. <ul class="tsd-parameters">
  405. <li class="tsd-parameter-signature">
  406. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  407. <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>
  408. </ul>
  409. <ul class="tsd-descriptions">
  410. <li class="tsd-description">
  411. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  412. </li>
  413. </ul>
  414. </li>
  415. </ul>
  416. </div>
  417. </section>
  418. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  419. <a name="sethovercallback" class="tsd-anchor"></a>
  420. <h3>set<wbr>Hover<wbr>Callback</h3>
  421. <div class="tsd-signature tsd-kind-icon">set<wbr>Hover<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  422. <aside class="tsd-sources">
  423. <ul>
  424. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:15</li>
  425. </ul>
  426. </aside>
  427. <div class="tsd-type-declaration">
  428. <h4>Type declaration</h4>
  429. <ul class="tsd-parameters">
  430. <li class="tsd-parameter-signature">
  431. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  432. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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><span class="tsd-signature-type">void</span></li>
  433. </ul>
  434. <ul class="tsd-descriptions">
  435. <li class="tsd-description">
  436. <h4 class="tsd-parameters-title">Parameters</h4>
  437. <ul class="tsd-parameters">
  438. <li>
  439. <h5>g: <span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
  440. <ul class="tsd-parameters">
  441. <li class="tsd-parameter-signature">
  442. <ul class="tsd-signatures tsd-kind-type-literal">
  443. <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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  444. </ul>
  445. <ul class="tsd-descriptions">
  446. <li class="tsd-description">
  447. <h4 class="tsd-parameters-title">Parameters</h4>
  448. <ul class="tsd-parameters">
  449. <li>
  450. <h5><span class="tsd-flag ts-flagOptional">Optional</span> flag: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
  451. </li>
  452. </ul>
  453. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  454. </li>
  455. </ul>
  456. </li>
  457. </ul>
  458. </li>
  459. </ul>
  460. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  461. </li>
  462. </ul>
  463. </li>
  464. </ul>
  465. </div>
  466. </section>
  467. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  468. <a name="setmodelchangecallback" class="tsd-anchor"></a>
  469. <h3>set<wbr>Model<wbr>Change<wbr>Callback</h3>
  470. <div class="tsd-signature tsd-kind-icon">set<wbr>Model<wbr>Change<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  471. <aside class="tsd-sources">
  472. <ul>
  473. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:14</li>
  474. </ul>
  475. </aside>
  476. <div class="tsd-type-declaration">
  477. <h4>Type declaration</h4>
  478. <ul class="tsd-parameters">
  479. <li class="tsd-parameter-signature">
  480. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  481. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><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"> =&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">void</span></li>
  482. </ul>
  483. <ul class="tsd-descriptions">
  484. <li class="tsd-description">
  485. <h4 class="tsd-parameters-title">Parameters</h4>
  486. <ul class="tsd-parameters">
  487. <li>
  488. <h5>f: <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"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
  489. <ul class="tsd-parameters">
  490. <li class="tsd-parameter-signature">
  491. <ul class="tsd-signatures tsd-kind-type-literal">
  492. <li class="tsd-signature tsd-kind-icon"><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>
  493. </ul>
  494. <ul class="tsd-descriptions">
  495. <li class="tsd-description">
  496. <h4 class="tsd-parameters-title">Parameters</h4>
  497. <ul class="tsd-parameters">
  498. <li>
  499. <h5>modelMap: <a href="../globals.html#saguaropluginmodelmaptype" class="tsd-signature-type">SaguaroPluginModelMapType</a></h5>
  500. </li>
  501. </ul>
  502. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  503. </li>
  504. </ul>
  505. </li>
  506. </ul>
  507. </li>
  508. </ul>
  509. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  510. </li>
  511. </ul>
  512. </li>
  513. </ul>
  514. </div>
  515. </section>
  516. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  517. <a name="setrepresentationchangecallback" class="tsd-anchor"></a>
  518. <h3>set<wbr>Representation<wbr>Change<wbr>Callback</h3>
  519. <div class="tsd-signature tsd-kind-icon">set<wbr>Representation<wbr>Change<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  520. <aside class="tsd-sources">
  521. <ul>
  522. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:16</li>
  523. </ul>
  524. </aside>
  525. <div class="tsd-type-declaration">
  526. <h4>Type declaration</h4>
  527. <ul class="tsd-parameters">
  528. <li class="tsd-parameter-signature">
  529. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  530. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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><span class="tsd-signature-type">void</span></li>
  531. </ul>
  532. <ul class="tsd-descriptions">
  533. <li class="tsd-description">
  534. <h4 class="tsd-parameters-title">Parameters</h4>
  535. <ul class="tsd-parameters">
  536. <li>
  537. <h5>g: <span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
  538. <ul class="tsd-parameters">
  539. <li class="tsd-parameter-signature">
  540. <ul class="tsd-signatures tsd-kind-type-literal">
  541. <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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  542. </ul>
  543. <ul class="tsd-descriptions">
  544. <li class="tsd-description">
  545. <h4 class="tsd-parameters-title">Parameters</h4>
  546. <ul class="tsd-parameters">
  547. <li>
  548. <h5><span class="tsd-flag ts-flagOptional">Optional</span> flag: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
  549. </li>
  550. </ul>
  551. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  552. </li>
  553. </ul>
  554. </li>
  555. </ul>
  556. </li>
  557. </ul>
  558. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  559. </li>
  560. </ul>
  561. </li>
  562. </ul>
  563. </div>
  564. </section>
  565. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  566. <a name="setselectcallback" class="tsd-anchor"></a>
  567. <h3>set<wbr>Select<wbr>Callback</h3>
  568. <div class="tsd-signature tsd-kind-icon">set<wbr>Select<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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"> =&gt; </span><span class="tsd-signature-type">void</span></div>
  569. <aside class="tsd-sources">
  570. <ul>
  571. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:13</li>
  572. </ul>
  573. </aside>
  574. <div class="tsd-type-declaration">
  575. <h4>Type declaration</h4>
  576. <ul class="tsd-parameters">
  577. <li class="tsd-parameter-signature">
  578. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  579. <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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><span class="tsd-signature-type">void</span></li>
  580. </ul>
  581. <ul class="tsd-descriptions">
  582. <li class="tsd-description">
  583. <h4 class="tsd-parameters-title">Parameters</h4>
  584. <ul class="tsd-parameters">
  585. <li>
  586. <h5>g: <span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
  587. <ul class="tsd-parameters">
  588. <li class="tsd-parameter-signature">
  589. <ul class="tsd-signatures tsd-kind-type-literal">
  590. <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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  591. </ul>
  592. <ul class="tsd-descriptions">
  593. <li class="tsd-description">
  594. <h4 class="tsd-parameters-title">Parameters</h4>
  595. <ul class="tsd-parameters">
  596. <li>
  597. <h5><span class="tsd-flag ts-flagOptional">Optional</span> flag: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
  598. </li>
  599. </ul>
  600. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  601. </li>
  602. </ul>
  603. </li>
  604. </ul>
  605. </li>
  606. </ul>
  607. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  608. </li>
  609. </ul>
  610. </li>
  611. </ul>
  612. </div>
  613. </section>
  614. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  615. <a name="unsetcallbacks" class="tsd-anchor"></a>
  616. <h3>unset<wbr>Callbacks</h3>
  617. <div class="tsd-signature tsd-kind-icon">unset<wbr>Callbacks<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></div>
  618. <aside class="tsd-sources">
  619. <ul>
  620. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:17</li>
  621. </ul>
  622. </aside>
  623. <div class="tsd-type-declaration">
  624. <h4>Type declaration</h4>
  625. <ul class="tsd-parameters">
  626. <li class="tsd-parameter-signature">
  627. <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
  628. <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>
  629. </ul>
  630. <ul class="tsd-descriptions">
  631. <li class="tsd-description">
  632. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  633. </li>
  634. </ul>
  635. </li>
  636. </ul>
  637. </div>
  638. </section>
  639. </section>
  640. <section class="tsd-panel-group tsd-member-group tsd-is-inherited">
  641. <h2>Methods</h2>
  642. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  643. <a name="camerafocus" class="tsd-anchor"></a>
  644. <h3>camera<wbr>Focus</h3>
  645. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  646. <li class="tsd-signature tsd-kind-icon">camera<wbr>Focus<span class="tsd-signature-symbol">(</span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, positions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  647. <li class="tsd-signature tsd-kind-icon">camera<wbr>Focus<span class="tsd-signature-symbol">(</span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  648. </ul>
  649. <ul class="tsd-descriptions">
  650. <li class="tsd-description">
  651. <aside class="tsd-sources">
  652. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#camerafocus">cameraFocus</a></p>
  653. <ul>
  654. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:37</li>
  655. </ul>
  656. </aside>
  657. <h4 class="tsd-parameters-title">Parameters</h4>
  658. <ul class="tsd-parameters">
  659. <li>
  660. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  661. </li>
  662. <li>
  663. <h5>labelAsymId: <span class="tsd-signature-type">string</span></h5>
  664. </li>
  665. <li>
  666. <h5>positions: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h5>
  667. </li>
  668. </ul>
  669. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  670. </li>
  671. <li class="tsd-description">
  672. <aside class="tsd-sources">
  673. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#camerafocus">cameraFocus</a></p>
  674. <ul>
  675. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:38</li>
  676. </ul>
  677. </aside>
  678. <h4 class="tsd-parameters-title">Parameters</h4>
  679. <ul class="tsd-parameters">
  680. <li>
  681. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  682. </li>
  683. <li>
  684. <h5>labelAsymId: <span class="tsd-signature-type">string</span></h5>
  685. </li>
  686. <li>
  687. <h5>begin: <span class="tsd-signature-type">number</span></h5>
  688. </li>
  689. <li>
  690. <h5>end: <span class="tsd-signature-type">number</span></h5>
  691. </li>
  692. </ul>
  693. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  694. </li>
  695. </ul>
  696. </section>
  697. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  698. <a name="clearfocus" class="tsd-anchor"></a>
  699. <h3>clear<wbr>Focus</h3>
  700. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  701. <li class="tsd-signature tsd-kind-icon">clear<wbr>Focus<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>
  702. </ul>
  703. <ul class="tsd-descriptions">
  704. <li class="tsd-description">
  705. <aside class="tsd-sources">
  706. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#clearfocus">clearFocus</a></p>
  707. <ul>
  708. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:36</li>
  709. </ul>
  710. </aside>
  711. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  712. </li>
  713. </ul>
  714. </section>
  715. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  716. <a name="colorcomponent" class="tsd-anchor"></a>
  717. <h3>color<wbr>Component</h3>
  718. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  719. <li class="tsd-signature tsd-kind-icon">color<wbr>Component<span class="tsd-signature-symbol">(</span>componentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ColorTheme.BuiltIn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  720. </ul>
  721. <ul class="tsd-descriptions">
  722. <li class="tsd-description">
  723. <aside class="tsd-sources">
  724. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#colorcomponent">colorComponent</a></p>
  725. <ul>
  726. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:29</li>
  727. </ul>
  728. </aside>
  729. <h4 class="tsd-parameters-title">Parameters</h4>
  730. <ul class="tsd-parameters">
  731. <li>
  732. <h5>componentId: <span class="tsd-signature-type">string</span></h5>
  733. </li>
  734. <li>
  735. <h5>color: <span class="tsd-signature-type">ColorTheme.BuiltIn</span></h5>
  736. </li>
  737. </ul>
  738. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  739. </li>
  740. </ul>
  741. </section>
  742. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  743. <a name="createcomponent" class="tsd-anchor"></a>
  744. <h3>create<wbr>Component</h3>
  745. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  746. <li class="tsd-signature tsd-kind-icon">create<wbr>Component<span class="tsd-signature-symbol">(</span>componentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, representationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  747. <li class="tsd-signature tsd-kind-icon">create<wbr>Component<span class="tsd-signature-symbol">(</span>componentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, representationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  748. <li class="tsd-signature tsd-kind-icon">create<wbr>Component<span class="tsd-signature-symbol">(</span>componentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, residues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span>, representationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  749. <li class="tsd-signature tsd-kind-icon">create<wbr>Component<span class="tsd-signature-symbol">(</span>componentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, residues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span>, representationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  750. </ul>
  751. <ul class="tsd-descriptions">
  752. <li class="tsd-description">
  753. <aside class="tsd-sources">
  754. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#createcomponent">createComponent</a></p>
  755. <ul>
  756. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:25</li>
  757. </ul>
  758. </aside>
  759. <h4 class="tsd-parameters-title">Parameters</h4>
  760. <ul class="tsd-parameters">
  761. <li>
  762. <h5>componentId: <span class="tsd-signature-type">string</span></h5>
  763. </li>
  764. <li>
  765. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  766. </li>
  767. <li>
  768. <h5>labelAsymId: <span class="tsd-signature-type">string</span></h5>
  769. </li>
  770. <li>
  771. <h5>begin: <span class="tsd-signature-type">number</span></h5>
  772. </li>
  773. <li>
  774. <h5>end: <span class="tsd-signature-type">number</span></h5>
  775. </li>
  776. <li>
  777. <h5>representationType: <span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span></h5>
  778. </li>
  779. </ul>
  780. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  781. </li>
  782. <li class="tsd-description">
  783. <aside class="tsd-sources">
  784. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#createcomponent">createComponent</a></p>
  785. <ul>
  786. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:26</li>
  787. </ul>
  788. </aside>
  789. <h4 class="tsd-parameters-title">Parameters</h4>
  790. <ul class="tsd-parameters">
  791. <li>
  792. <h5>componentId: <span class="tsd-signature-type">string</span></h5>
  793. </li>
  794. <li>
  795. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  796. </li>
  797. <li>
  798. <h5>labelAsymId: <span class="tsd-signature-type">string</span></h5>
  799. </li>
  800. <li>
  801. <h5>representationType: <span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span></h5>
  802. </li>
  803. </ul>
  804. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  805. </li>
  806. <li class="tsd-description">
  807. <aside class="tsd-sources">
  808. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#createcomponent">createComponent</a></p>
  809. <ul>
  810. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:27</li>
  811. </ul>
  812. </aside>
  813. <h4 class="tsd-parameters-title">Parameters</h4>
  814. <ul class="tsd-parameters">
  815. <li>
  816. <h5>componentId: <span class="tsd-signature-type">string</span></h5>
  817. </li>
  818. <li>
  819. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  820. </li>
  821. <li>
  822. <h5>residues: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h5>
  823. </li>
  824. <li>
  825. <h5>representationType: <span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span></h5>
  826. </li>
  827. </ul>
  828. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  829. </li>
  830. <li class="tsd-description">
  831. <aside class="tsd-sources">
  832. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#createcomponent">createComponent</a></p>
  833. <ul>
  834. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:28</li>
  835. </ul>
  836. </aside>
  837. <h4 class="tsd-parameters-title">Parameters</h4>
  838. <ul class="tsd-parameters">
  839. <li>
  840. <h5>componentId: <span class="tsd-signature-type">string</span></h5>
  841. </li>
  842. <li>
  843. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  844. </li>
  845. <li>
  846. <h5>residues: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h5>
  847. </li>
  848. <li>
  849. <h5>representationType: <span class="tsd-signature-type">StructureRepresentationRegistry.BuiltIn</span></h5>
  850. </li>
  851. </ul>
  852. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  853. </li>
  854. </ul>
  855. </section>
  856. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  857. <a name="displaycomponent" class="tsd-anchor"></a>
  858. <h3>display<wbr>Component</h3>
  859. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  860. <li class="tsd-signature tsd-kind-icon">display<wbr>Component<span class="tsd-signature-symbol">(</span>componentLabel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, visibilityFlag<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>
  861. <li class="tsd-signature tsd-kind-icon">display<wbr>Component<span class="tsd-signature-symbol">(</span>componentLabel<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">boolean</span></li>
  862. </ul>
  863. <ul class="tsd-descriptions">
  864. <li class="tsd-description">
  865. <aside class="tsd-sources">
  866. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#displaycomponent">displayComponent</a></p>
  867. <ul>
  868. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:32</li>
  869. </ul>
  870. </aside>
  871. <h4 class="tsd-parameters-title">Parameters</h4>
  872. <ul class="tsd-parameters">
  873. <li>
  874. <h5>componentLabel: <span class="tsd-signature-type">string</span></h5>
  875. </li>
  876. <li>
  877. <h5>visibilityFlag: <span class="tsd-signature-type">boolean</span></h5>
  878. </li>
  879. </ul>
  880. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  881. </li>
  882. <li class="tsd-description">
  883. <aside class="tsd-sources">
  884. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#displaycomponent">displayComponent</a></p>
  885. <ul>
  886. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:33</li>
  887. </ul>
  888. </aside>
  889. <h4 class="tsd-parameters-title">Parameters</h4>
  890. <ul class="tsd-parameters">
  891. <li>
  892. <h5>componentLabel: <span class="tsd-signature-type">string</span></h5>
  893. </li>
  894. </ul>
  895. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  896. </li>
  897. </ul>
  898. </section>
  899. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  900. <a name="select" class="tsd-anchor"></a>
  901. <h3>select</h3>
  902. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  903. <li class="tsd-signature tsd-kind-icon">select<span class="tsd-signature-symbol">(</span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span>, operation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"set"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"add"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  904. <li class="tsd-signature tsd-kind-icon">select<span class="tsd-signature-symbol">(</span>selection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span>, mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span>, operation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"add"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"set"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  905. <li class="tsd-signature tsd-kind-icon">select<span class="tsd-signature-symbol">(</span>selection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span>, mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span>, operation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"add"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"set"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  906. </ul>
  907. <ul class="tsd-descriptions">
  908. <li class="tsd-description">
  909. <aside class="tsd-sources">
  910. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#select">select</a></p>
  911. <ul>
  912. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:21</li>
  913. </ul>
  914. </aside>
  915. <h4 class="tsd-parameters-title">Parameters</h4>
  916. <ul class="tsd-parameters">
  917. <li>
  918. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  919. </li>
  920. <li>
  921. <h5>labelAsymId: <span class="tsd-signature-type">string</span></h5>
  922. </li>
  923. <li>
  924. <h5>x: <span class="tsd-signature-type">number</span></h5>
  925. </li>
  926. <li>
  927. <h5>y: <span class="tsd-signature-type">number</span></h5>
  928. </li>
  929. <li>
  930. <h5>mode: <span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span></h5>
  931. </li>
  932. <li>
  933. <h5>operation: <span class="tsd-signature-type">"set"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"add"</span></h5>
  934. </li>
  935. </ul>
  936. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  937. </li>
  938. <li class="tsd-description">
  939. <aside class="tsd-sources">
  940. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#select">select</a></p>
  941. <ul>
  942. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:22</li>
  943. </ul>
  944. </aside>
  945. <h4 class="tsd-parameters-title">Parameters</h4>
  946. <ul class="tsd-parameters">
  947. <li>
  948. <h5>selection: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h5>
  949. </li>
  950. <li>
  951. <h5>mode: <span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span></h5>
  952. </li>
  953. <li>
  954. <h5>operation: <span class="tsd-signature-type">"add"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"set"</span></h5>
  955. </li>
  956. </ul>
  957. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  958. </li>
  959. <li class="tsd-description">
  960. <aside class="tsd-sources">
  961. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#select">select</a></p>
  962. <ul>
  963. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:23</li>
  964. </ul>
  965. </aside>
  966. <h4 class="tsd-parameters-title">Parameters</h4>
  967. <ul class="tsd-parameters">
  968. <li>
  969. <h5>selection: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h5>
  970. </li>
  971. <li>
  972. <h5>mode: <span class="tsd-signature-type">"select"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hover"</span></h5>
  973. </li>
  974. <li>
  975. <h5>operation: <span class="tsd-signature-type">"add"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"set"</span></h5>
  976. </li>
  977. </ul>
  978. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  979. </li>
  980. </ul>
  981. </section>
  982. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  983. <a name="setfocus" class="tsd-anchor"></a>
  984. <h3>set<wbr>Focus</h3>
  985. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  986. <li class="tsd-signature tsd-kind-icon">set<wbr>Focus<span class="tsd-signature-symbol">(</span>modelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, labelAsymId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, begin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  987. </ul>
  988. <ul class="tsd-descriptions">
  989. <li class="tsd-description">
  990. <aside class="tsd-sources">
  991. <p>Inherited from <a href="saguaroplugininterface.html">SaguaroPluginInterface</a>.<a href="saguaroplugininterface.html#setfocus">setFocus</a></p>
  992. <ul>
  993. <li>Defined in src/RcsbFvStructure/StructurePlugins/SaguaroPluginInterface.ts:35</li>
  994. </ul>
  995. </aside>
  996. <h4 class="tsd-parameters-title">Parameters</h4>
  997. <ul class="tsd-parameters">
  998. <li>
  999. <h5>modelId: <span class="tsd-signature-type">string</span></h5>
  1000. </li>
  1001. <li>
  1002. <h5>labelAsymId: <span class="tsd-signature-type">string</span></h5>
  1003. </li>
  1004. <li>
  1005. <h5>begin: <span class="tsd-signature-type">number</span></h5>
  1006. </li>
  1007. <li>
  1008. <h5>end: <span class="tsd-signature-type">number</span></h5>
  1009. </li>
  1010. </ul>
  1011. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1012. </li>
  1013. </ul>
  1014. </section>
  1015. </section>
  1016. </div>
  1017. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  1018. <nav class="tsd-navigation primary">
  1019. <ul>
  1020. <li class="globals ">
  1021. <a href="../globals.html"><em>Globals</em></a>
  1022. </li>
  1023. </ul>
  1024. </nav>
  1025. <nav class="tsd-navigation secondary menu-sticky">
  1026. <ul class="before-current">
  1027. </ul>
  1028. <ul class="current">
  1029. <li class="current tsd-kind-interface">
  1030. <a href="saguaroplugininterface.html" class="tsd-kind-icon">Saguaro<wbr>Plugin<wbr>Interface</a>
  1031. <ul>
  1032. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1033. <a href="saguaroplugininterface.html#clear" class="tsd-kind-icon">clear</a>
  1034. </li>
  1035. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  1036. <a href="saguaroplugininterface.html#clearselection" class="tsd-kind-icon">clear<wbr>Selection</a>
  1037. </li>
  1038. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  1039. <a href="saguaroplugininterface.html#getcomponentset" class="tsd-kind-icon">get<wbr>Component<wbr>Set</a>
  1040. </li>
  1041. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1042. <a href="saguaroplugininterface.html#init" class="tsd-kind-icon">init</a>
  1043. </li>
  1044. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  1045. <a href="saguaroplugininterface.html#iscomponent" class="tsd-kind-icon">is<wbr>Component</a>
  1046. </li>
  1047. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1048. <a href="saguaroplugininterface.html#load" class="tsd-kind-icon">load</a>
  1049. </li>
  1050. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1051. <a href="saguaroplugininterface.html#plugincall" class="tsd-kind-icon">plugin<wbr>Call</a>
  1052. </li>
  1053. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  1054. <a href="saguaroplugininterface.html#removecomponent" class="tsd-kind-icon">remove<wbr>Component</a>
  1055. </li>
  1056. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
  1057. <a href="saguaroplugininterface.html#resetcamera" class="tsd-kind-icon">reset<wbr>Camera</a>
  1058. </li>
  1059. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1060. <a href="saguaroplugininterface.html#sethovercallback" class="tsd-kind-icon">set<wbr>Hover<wbr>Callback</a>
  1061. </li>
  1062. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1063. <a href="saguaroplugininterface.html#setmodelchangecallback" class="tsd-kind-icon">set<wbr>Model<wbr>Change<wbr>Callback</a>
  1064. </li>
  1065. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1066. <a href="saguaroplugininterface.html#setrepresentationchangecallback" class="tsd-kind-icon">set<wbr>Representation<wbr>Change<wbr>Callback</a>
  1067. </li>
  1068. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1069. <a href="saguaroplugininterface.html#setselectcallback" class="tsd-kind-icon">set<wbr>Select<wbr>Callback</a>
  1070. </li>
  1071. <li class=" tsd-kind-property tsd-parent-kind-interface">
  1072. <a href="saguaroplugininterface.html#unsetcallbacks" class="tsd-kind-icon">unset<wbr>Callbacks</a>
  1073. </li>
  1074. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  1075. <a href="saguaroplugininterface.html#camerafocus" class="tsd-kind-icon">camera<wbr>Focus</a>
  1076. </li>
  1077. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  1078. <a href="saguaroplugininterface.html#clearfocus" class="tsd-kind-icon">clear<wbr>Focus</a>
  1079. </li>
  1080. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  1081. <a href="saguaroplugininterface.html#colorcomponent" class="tsd-kind-icon">color<wbr>Component</a>
  1082. </li>
  1083. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  1084. <a href="saguaroplugininterface.html#createcomponent" class="tsd-kind-icon">create<wbr>Component</a>
  1085. </li>
  1086. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  1087. <a href="saguaroplugininterface.html#displaycomponent" class="tsd-kind-icon">display<wbr>Component</a>
  1088. </li>
  1089. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  1090. <a href="saguaroplugininterface.html#select" class="tsd-kind-icon">select</a>
  1091. </li>
  1092. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
  1093. <a href="saguaroplugininterface.html#setfocus" class="tsd-kind-icon">set<wbr>Focus</a>
  1094. </li>
  1095. </ul>
  1096. </li>
  1097. </ul>
  1098. <ul class="after-current">
  1099. </ul>
  1100. </nav>
  1101. </div>
  1102. </div>
  1103. </div>
  1104. <footer class="with-border-bottom">
  1105. <div class="container">
  1106. <h2>Legend</h2>
  1107. <div class="tsd-legend-group">
  1108. <ul class="tsd-legend">
  1109. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  1110. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  1111. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  1112. </ul>
  1113. <ul class="tsd-legend">
  1114. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  1115. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  1116. </ul>
  1117. <ul class="tsd-legend">
  1118. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  1119. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  1120. </ul>
  1121. <ul class="tsd-legend">
  1122. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  1123. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  1124. </ul>
  1125. <ul class="tsd-legend">
  1126. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  1127. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  1128. </ul>
  1129. </div>
  1130. </div>
  1131. </footer>
  1132. <div class="container tsd-generator">
  1133. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  1134. </div>
  1135. <div class="overlay"></div>
  1136. <script src="../assets/js/main.js"></script>
  1137. </body>
  1138. </html>