CellexalVR.General.AnnotationManager Class Reference

Handles annotations on graphs. Annotations are notes added to certain groups of cells. They can be read from file or added via the gene keyboard. More...

Inheritance diagram for CellexalVR.General.AnnotationManager:

Public Member Functions
void	AddManualAnnotation (string s)
void	ToggleAnnotationFile (string path, bool toggle)
void	ClearAllAnnotations ()
void	AddAnnotation (string annotation, int index, string gpLabel)
	Adds the annotation to the currently selected group of cells. Also adds a line and text object above the cells with the annotation. More...
void	AddAnnotation (string annotation, string[] cellsToAnnotate, int index, string gpLabel)
void	AddAnnotation (string annotation, string[] cellsToAnnotate, string gpLabelToSpawnAt, int group, string path="")
	Adds the annotation to the specified graphpoints. For example when reading from an annotation file. More...
void	DumpAnnotatedSelectionToTextFile (string filePath="")
	Writes the cells that have added annotation to a text file. Only cell id and annotation is written to the file. More...
void	ExportToMetaCellFile ()

Public Attributes
GameObject	annotationTextPrefab
ReferenceManager	referenceManager

Detailed Description

Handles annotations on graphs. Annotations are notes added to certain groups of cells. They can be read from file or added via the gene keyboard.

Member Function Documentation

AddAnnotation() [1/2]

void CellexalVR.General.AnnotationManager.AddAnnotation	(	string	annotation,
		int	index,
		string	gpLabel
	)

Adds the annotation to the currently selected group of cells. Also adds a line and text object above the cells with the annotation.

Parameters

annotation	The text that will be shown above the cells and later written to file.
index	The index of the selection group.

AddAnnotation() [2/2]

void CellexalVR.General.AnnotationManager.AddAnnotation	(	string	annotation,
		string[]	cellsToAnnotate,
		string	gpLabelToSpawnAt,
		int	group,
		string	path = ""
	)

Adds the annotation to the specified graphpoints. For example when reading from an annotation file.

Parameters

annotation	The annotation string.
pointsToAnnotate	The points to annotate.

DumpAnnotatedSelectionToTextFile()

void CellexalVR.General.AnnotationManager.DumpAnnotatedSelectionToTextFile

(

string

filePath = ""

)

Writes the cells that have added annotation to a text file. Only cell id and annotation is written to the file.

Parameters

selection	The selected graphpoints
filePath
annotation	The string to write next to cell id as annotation.

---

The documentation for this class was generated from the following file:

• cellexalvr_cloudxr/Assets/Scripts/General/AnnotationManager.cs