org.cytoscape.view.presentation.annotations

Interface AnnotationManager

public interface AnnotationManager

The annotation manager is responsible for managing all of the annotations currently assigned to a particular org.cytoscape.view.model.NetworkView. Annotations must be added to the annotation manager to be displayed.

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: presentation-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>presentation-api</artifactId>
</dependency>

Method Summary

Methods

Modifier and Type	Method and Description
void	addAnnotation(Annotation annotation) Add an annotation to the specified network view.
List<Annotation>	getAnnotations(CyNetworkView networkView) Retrieve the list of annotations for a specific network view.
void	removeAnnotation(Annotation annotation) Remove an annotation from its network view.

Method Detail

addAnnotation

void addAnnotation(Annotation annotation)

Add an annotation to the specified network view.

Parameters:

annotation - the annotation to add

networkView - the network view to add this annotation to

removeAnnotation

void removeAnnotation(Annotation annotation)

Remove an annotation from its network view. If there are no other references to this annotation, it will be garbage collected.

Parameters:

annotation - the annotation to remove

getAnnotations

List<Annotation> getAnnotations(CyNetworkView networkView)

Retrieve the list of annotations for a specific network view.

Parameters:

networkView - the network view to get the list from

Returns:

the list of annotations