Class SimilarityPanel

Class component in charge of loading similarity data and displaying information about the current loaded dataset

Index

Constructors

Methods

addSimilarityFunctionToDropdown init updateCasebaseDescription updatePanelTitle

Constructors

constructor

new SimilarityPanel(): SimilarityPanel
Constructor

Returns SimilarityPanel
- Defined in src/js/Components/similarityPanel.ts:36

Methods

addSimilarityFunctionToDropdown

addSimilarityFunctionToDropdown(simFunctionName, andSelect?): void
Add a new similarity function to the dropdown element of the similarity panel. By default, the similarity function is added but the function is not selected. However, it can be automatically selected using the "andSelect" parameter
Parameters
- simFunctionName: string
  Name of the similarity function added
- andSelect: boolean = false
  If true, it changes the dropdown to the added similarity function (and loads it)
Returns void
- Defined in src/js/Components/similarityPanel.ts:163

init

init(): void
Initialize the similarity panel using the DAOs already loaded

Returns void
- Defined in src/js/Components/similarityPanel.ts:46

updateCasebaseDescription

updateCasebaseDescription(casebaseName, casebaseDescription, numCases): void
Updates the casebase description panel with dataset information.
Parameters
- casebaseName: string
  The name of the casebase to display in the panel title
- casebaseDescription: string
  The description text of the casebase (supports markdown)
- numCases: number
  The total number of cases/instances in the casebase
Returns void
- Defined in src/js/Components/similarityPanel.ts:141

updatePanelTitle

updatePanelTitle(newTitle): void
Updates the panel title displayed on the top of the panel
Parameters
- newTitle: string
  The new title displayed in the panel
Returns void
- Defined in src/js/Components/similarityPanel.ts:93