<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>CustomViewInterface | @rcsb/rcsb-saguaro-3d</title> <meta name="description" content="Documentation for @rcsb/rcsb-saguaro-3d"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@rcsb/rcsb-saguaro-3d</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="customviewinterface.html">CustomViewInterface</a> </li> </ul> <h1>Interface CustomViewInterface</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">CustomViewInterface</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customviewinterface.html#blockchangecallback" class="tsd-kind-icon">block<wbr>Change<wbr>Callback</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customviewinterface.html#blockconfig" class="tsd-kind-icon">block<wbr>Config</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customviewinterface.html#blockselectorelement" class="tsd-kind-icon">block<wbr>Selector<wbr>Element</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customviewinterface.html#modelchangecallback" class="tsd-kind-icon">model<wbr>Change<wbr>Callback</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="blockchangecallback" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr>Change<wbr>Callback</h3> <div class="tsd-signature tsd-kind-icon">block<wbr>Change<wbr>Callback<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><span class="tsd-signature-symbol">(</span>plugin<span class="tsd-signature-symbol">: </span><a href="saguaropluginpublicinterface.html" class="tsd-signature-type">SaguaroPluginPublicInterface</a>, pfvList<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RcsbFv</span><span class="tsd-signature-symbol">></span>, selection<span class="tsd-signature-symbol">: </span><a href="../classes/rcsbfvselectormanager.html" class="tsd-signature-type">RcsbFvSelectorManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:23</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="blockconfig" class="tsd-anchor"></a> <h3>block<wbr>Config</h3> <div class="tsd-signature tsd-kind-icon">block<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="featureblockinterface.html" class="tsd-signature-type">FeatureBlockInterface</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="featureblockinterface.html" class="tsd-signature-type">FeatureBlockInterface</a><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:20</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="blockselectorelement" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr>Selector<wbr>Element</h3> <div class="tsd-signature tsd-kind-icon">block<wbr>Selector<wbr>Element<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><span class="tsd-signature-symbol">(</span>blockSelector<span class="tsd-signature-symbol">: </span><a href="../classes/blockselectormanager.html" class="tsd-signature-type">BlockSelectorManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:21</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="modelchangecallback" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> model<wbr>Change<wbr>Callback</h3> <div class="tsd-signature tsd-kind-icon">model<wbr>Change<wbr>Callback<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><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><a href="../globals.html#customviewstateinterface" class="tsd-signature-type">CustomViewStateInterface</a><span class="tsd-signature-symbol">)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/RcsbFvSequence/SequenceViews/CustomView.tsx:22</li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="customviewinterface.html" class="tsd-kind-icon">Custom<wbr>View<wbr>Interface</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="customviewinterface.html#blockchangecallback" class="tsd-kind-icon">block<wbr>Change<wbr>Callback</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="customviewinterface.html#blockconfig" class="tsd-kind-icon">block<wbr>Config</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="customviewinterface.html#blockselectorelement" class="tsd-kind-icon">block<wbr>Selector<wbr>Element</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="customviewinterface.html#modelchangecallback" class="tsd-kind-icon">model<wbr>Change<wbr>Callback</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>