Package org.cytoscape.view.presentation.annotations

package org.cytoscape.view.presentation.annotations

This package provides support for graphical annotations associated with a Cytoscape CyNetworkView. Annotations currently include shapes ShapeAnnotation, text TextAnnotation, bounded text BoundedTextAnnotation, and images ImageAnnotation. In addition to the standard annotations the pacakge also supports connectors ArrowAnnotation that can connect an annotation to a point, another annotation, or to a CyNode.

Annotations are created by calls to the appropriate org.cytoscape.view.presentation.annotations.AnnotationFactory#createAnnotation(). In general, each annotation type has it's own AnnotationFactory. To get the correct factory, in your CyActivator, you will need do a filtered org.cytoscape.service.util.AbstractCyActivator#getService():
AnnotationFactory<ShapeAnnotation> shapeFactory = getService(bc, AnnotationFactory.class, "(type=ShapeAnnotation.class)");
Once an annotation is created, it must be added to the AnnotationManager, which will actually draw the annotation on the canvas.

In general, each type of annotation has it's own set of getter and setter routines that are appropriate for annotation type. Annotations are serialized and deserialized through CyTable entries. Annotation parameters may be set at creation time by setting the appropriate values in a arg map.

Interface Summary

Interface	Description
Annotation	This is the base interface for all Annotations.
AnnotationFactory<T extends Annotation>	An interface describing a factory used to create Annotations.
AnnotationManager	The annotation manager is responsible for managing all of the annotations currently assigned to a particular org.cytoscape.view.model.NetworkView.
ArrowAnnotation	This is the interface for an arrow annotation.
BoundedTextAnnotation	The BoundedText annotation is a ShapeAnnotation that also implements Text.
GroupAnnotation	The GroupAnnotation is a container for a collection of annotations that should be grouped together.
ImageAnnotation	This annotation positions an image on on the screen.
ShapeAnnotation	A Shape annotation supports annotations that can be drawn and filled on the graphics canvas.
TextAnnotation	A text annotation is a simple text string that is displayed on the network canvas.

Enum Class Summary

Enum Class	Description
ArrowAnnotation.AnchorType	This enum is used to indicate how the arrow is anchored to the source or target.
ArrowAnnotation.ArrowEnd	This enum is used to indicate which end of the arrow the operation is referring to.
ShapeAnnotation.ShapeType