docs

rcsb · Nov 20, 2023 · 5b5f3c5 · 5b5f3c5
1 parent 40c1d35
commit 5b5f3c5
Show file tree

Hide file tree

Showing 218 changed files with 653 additions and 653 deletions.
diff --git a/README.md b/README.md
@@ -39,32 +39,32 @@ Go to:
 - `http://localhost:9000/MultipleAlignment.html`
 
 ### CDN JavaScript
-`<script src="https://cdn.jsdelivr.net/npm/@rcsb/rcsb-saguaro/build/rcsb-saguaro.js" type="text/javascript"></script>`
+`<script src="https://cdn.jsdelivr.net/npm/@rcsb/rcsb-saguaro/build/rcsb-saguaro.min.js" type="text/javascript"></script>`
 
 ### Library Documentation
-TypeScript full classes documentation can be found [here](https://rcsb.github.io/rcsb-saguaro/modules.html).
+TypeScript full classes documentation can be found [here](https://rcsb.github.io/rcsb-saguaro/index.html).
 
 ### Main Classes and Interfaces
 These are the most important elements if you are only interested in using RCSB Saguaro to visualise protein annotations
 
-- [RcsbFv](https://rcsb.github.io/rcsb-saguaro/classes/RcsbFv.html): 
+- [RcsbFv](https://rcsb.github.io/rcsb-saguaro/classes/RcsbFv_RcsbFv.RcsbFv.html): 
 Main feature viewer class that can be used to create, configure and render a feature viewer object. It includes different methods to 
 change viewer configuration, add new tracks, replace or update track data or change track visibility
-- [RcsbFvBoardConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFvBoardConfigInterface.html):
+- [RcsbFvBoardConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFv_RcsbFvConfig_RcsbFvConfigInterface.RcsbFvBoardConfigInterface.html):
 Feature viewer configuration interface that defines the different properties to configure the feature viewer main panel 
 including track title and annotation cells width, activate tooltips flag and annotation click and hovering callbacks
-- [RcsbFvRowConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFvRowConfigInterface.html): 
+- [RcsbFvRowConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFv_RcsbFvConfig_RcsbFvConfigInterface.RcsbFvRowExtendedConfigInterface.html): 
 This interface can be used to set up the configuration for feature viewer tracks. It includes multiple properties that define how track features 
 are displayed (color, shape, overlap flag) and also different track attributes (background color, track height, track title, track visibility)
-- [RcsbFvTrackDataElementInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFvTrackDataElementInterface.html)
+- [RcsbFvTrackDataElementInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbDataManager_RcsbDataManager.RcsbFvTrackDataElementInterface.html)
 Interface that defines properties of an specific annotation object. It includes the location where the annotation will be displayed 
 (begin, end) and additional properties to change the final representation and click-event behaviour 
 
 General Board and Track Configuration
 ---
 #### Board Configuration
 Main feature viewer board object configuration defines the coordinate range, track and title width and axis display. 
-The full set of attributes is defined in [RcsbFvBoardConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFvBoardConfigInterface.html)
+The full set of attributes is defined in [RcsbFvBoardConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFv_RcsbFvConfig_RcsbFvConfigInterface.RcsbFvBoardConfigInterface.html)
 interface.
 
 Main Board Configuration properties are:
@@ -87,15 +87,15 @@ const boardConfig = {
 };
 ```
 #### Track Configuration
-Row configuration object defines format and content of feature viewer rows. The full set of board row configuration attributes is defined in [RcsbFvRowConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFvRowConfigInterface.html).
+Row configuration object defines format and content of feature viewer rows. The full set of board row configuration attributes is defined in [RcsbFvRowConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFv_RcsbFvConfig_RcsbFvConfigInterface.RcsbFvRowExtendedConfigInterface.html).
 
 Main Row Configuration properties are:
 - **trackHeight**: Defines the board row height
 - **trackColor**: Color in which row data will be displayed 
 - **rowTitle**: Board track title, text displayed next to the board row
 - **displayType**: Enumerated value used to define how the data is displayed
   - Values: sequence, block, pin, line, area, bond, vline
-- **trackData**: List of data displayed in the board row. The full set o data attributes are defined in [RcsbFvTrackDataElementInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFvTrackDataElementInterface.html). Most important data elements attributes are 
+- **trackData**: List of data displayed in the board row. The full set o data attributes are defined in [RcsbFvTrackDataElementInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbDataManager_RcsbDataManager.RcsbFvTrackDataElementInterface.html). Most important data elements attributes are 
   - **begin**: Start position of the feature
   - **end**: End position of the feature (optional value). When no end value is available the feature is located on a single position defined by *begin*
   - **value**: Numerical or string value of the feature in this range (optional value)

diff --git a/docs/classes/RcsbBoard_RcsbBoard.RcsbBoard.html b/docs/classes/RcsbBoard_RcsbBoard.RcsbBoard.html
diff --git a/docs/classes/RcsbBoard_RcsbD3_RcsbD3Constants.RcsbD3Constants.html b/docs/classes/RcsbBoard_RcsbD3_RcsbD3Constants.RcsbD3Constants.html
diff --git a/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3AreaManager.RcsbD3AreaManager.html b/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3AreaManager.RcsbD3AreaManager.html
diff --git a/.../classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3BlockManager.RcsbD3BlockManager.html b/.../classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3BlockManager.RcsbD3BlockManager.html
diff --git a/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3BondManager.RcsbD3BondManager.html b/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3BondManager.RcsbD3BondManager.html
diff --git a/...oard_RcsbD3_RcsbD3DisplayManager_RcsbD3FastSequenceManager.RcsbD3FastSequenceManager.html b/...oard_RcsbD3_RcsbD3DisplayManager_RcsbD3FastSequenceManager.RcsbD3FastSequenceManager.html
diff --git a/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3LineManager.RcsbD3LineManager.html b/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3LineManager.RcsbD3LineManager.html
diff --git a/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3PinManager.RcsbD3PinManager.html b/docs/classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3PinManager.RcsbD3PinManager.html
diff --git a/...es/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3SequenceManager.RcsbD3SequenceManager.html b/...es/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3SequenceManager.RcsbD3SequenceManager.html
diff --git a/...sses/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3VariantManager.RcsbD3VariantManager.html b/...sses/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3VariantManager.RcsbD3VariantManager.html
diff --git a/.../classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3VlineManager.RcsbD3VlineManager.html b/.../classes/RcsbBoard_RcsbD3_RcsbD3DisplayManager_RcsbD3VlineManager.RcsbD3VlineManager.html
diff --git a/docs/classes/RcsbBoard_RcsbD3_RcsbD3EventDispatcher.RcsbD3EventDispatcher.html b/docs/classes/RcsbBoard_RcsbD3_RcsbD3EventDispatcher.RcsbD3EventDispatcher.html
diff --git a/docs/classes/RcsbBoard_RcsbD3_RcsbD3Manager.RcsbD3Manager.html b/docs/classes/RcsbBoard_RcsbD3_RcsbD3Manager.RcsbD3Manager.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbAbstractDisplay.RcsbAbstractDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbAbstractDisplay.RcsbAbstractDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbAbstractTrack.RcsbAbstractTrack.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbAbstractTrack.RcsbAbstractTrack.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbAreaDisplay.RcsbAreaDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbAreaDisplay.RcsbAreaDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbAxisDisplay.RcsbAxisDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbAxisDisplay.RcsbAxisDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbBlockDisplay.RcsbBlockDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbBlockDisplay.RcsbBlockDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbBondDisplay.RcsbBondDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbBondDisplay.RcsbBondDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbCompositeDisplay.RcsbCompositeDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbCompositeDisplay.RcsbCompositeDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbFastSequenceDisplay.RcsbFastSequenceDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbFastSequenceDisplay.RcsbFastSequenceDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbLineDisplay.RcsbLineDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbLineDisplay.RcsbLineDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbPinDisplay.RcsbPinDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbPinDisplay.RcsbPinDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbVariantDisplay.RcsbVariantDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbVariantDisplay.RcsbVariantDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbDisplay_RcsbVlineDisplay.RcsbVlineDisplay.html b/docs/classes/RcsbBoard_RcsbDisplay_RcsbVlineDisplay.RcsbVlineDisplay.html
diff --git a/docs/classes/RcsbBoard_RcsbSelection.RcsbSelection.html b/docs/classes/RcsbBoard_RcsbSelection.RcsbSelection.html
diff --git a/docs/classes/RcsbDataManager_RcsbDataManager.RcsbDataManager.html b/docs/classes/RcsbDataManager_RcsbDataManager.RcsbDataManager.html
diff --git a/docs/classes/RcsbDataManager_RcsbDataManager.RcsbFvTrackData.html b/docs/classes/RcsbDataManager_RcsbDataManager.RcsbFvTrackData.html
diff --git a/docs/classes/RcsbDataManager_RcsbDataManager.RcsbFvTrackDataMap.html b/docs/classes/RcsbDataManager_RcsbDataManager.RcsbFvTrackDataMap.html
diff --git a/docs/classes/RcsbFv_RcsbFv.RcsbFv.html b/docs/classes/RcsbFv_RcsbFv.RcsbFv.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_Components_AxisRow.AxisRow.html b/docs/classes/RcsbFv_RcsbFvBoard_Components_AxisRow.AxisRow.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_Components_BoardGlow.BoardGlow.html b/docs/classes/RcsbFv_RcsbFvBoard_Components_BoardGlow.BoardGlow.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_Components_BoardProgress.BoardProgress.html b/docs/classes/RcsbFv_RcsbFvBoard_Components_BoardProgress.BoardProgress.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_Components_RowGlow.RowGlow.html b/docs/classes/RcsbFv_RcsbFvBoard_Components_RowGlow.RowGlow.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_RcsbFvBoard.RcsbFvBoard.html b/docs/classes/RcsbFv_RcsbFvBoard_RcsbFvBoard.RcsbFvBoard.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_RcsbFvTable.RcsbFvTable.html b/docs/classes/RcsbFv_RcsbFvBoard_RcsbFvTable.RcsbFvTable.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_Utils_BoardDataState.BoardDataState.html b/docs/classes/RcsbFv_RcsbFvBoard_Utils_BoardDataState.BoardDataState.html
diff --git a/docs/classes/RcsbFv_RcsbFvBoard_Utils_RowStatusMap.RowStatusMap.html b/docs/classes/RcsbFv_RcsbFvBoard_Utils_RowStatusMap.RowStatusMap.html
diff --git a/docs/classes/RcsbFv_RcsbFvConfig_RcsbFvConfig.RcsbFvConfig.html b/docs/classes/RcsbFv_RcsbFvConfig_RcsbFvConfig.RcsbFvConfig.html
diff --git a/docs/classes/RcsbFv_RcsbFvContextManager_RcsbFvContextManager.RcsbFvContextManager.html b/docs/classes/RcsbFv_RcsbFvContextManager_RcsbFvContextManager.RcsbFvContextManager.html
diff --git a/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRow.RcsbFvRow.html b/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRow.RcsbFvRow.html
diff --git a/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRowMark.RcsbFvRowMark.html b/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRowMark.RcsbFvRowMark.html
diff --git a/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRowTitle.RcsbFvRowTitle.html b/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRowTitle.RcsbFvRowTitle.html
diff --git a/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRowTrack.RcsbFvRowTrack.html b/docs/classes/RcsbFv_RcsbFvRow_RcsbFvRowTrack.RcsbFvRowTrack.html
diff --git a/docs/classes/RcsbFv_RcsbFvState_RcsbFvStateManager.RcsbFvStateManager.html b/docs/classes/RcsbFv_RcsbFvState_RcsbFvStateManager.RcsbFvStateManager.html
diff --git a/...classes/RcsbFv_RcsbFvTooltip_RcsbFvTooltipImplementation_RcsbFvTooltip.RcsbFvTooltip.html b/...classes/RcsbFv_RcsbFvTooltip_RcsbFvTooltipImplementation_RcsbFvTooltip.RcsbFvTooltip.html
diff --git a/docs/classes/RcsbFv_RcsbFvTooltip_RcsbFvTooltipManager.RcsbFvTooltipManager.html b/docs/classes/RcsbFv_RcsbFvTooltip_RcsbFvTooltipManager.RcsbFvTooltipManager.html
diff --git a/docs/classes/RcsbFv_RcsbFvTrack_RcsbFvDisplay.RcsbFvDisplay.html b/docs/classes/RcsbFv_RcsbFvTrack_RcsbFvDisplay.RcsbFvDisplay.html