Package org.eclipse.dawnsci.plotting.api.annotation

Interface IAnnotationSystem

All Known Subinterfaces:
IPlottingSystem<T>, IPlottingSystemViewer<T>
All Known Implementing Classes:
AbstractHyperPlotViewer, AbstractPlottingSystem, ArpesSlicePlotViewer, DatasetTablePlotViewer, HyperPlotViewer, IPlottingSystemViewer.Stub, JRealityPlotViewer, LightWeightPlotViewer, PlottingSystemImpl, ThreadSafePlottingSystem
public interface IAnnotationSystem
No methods in this interface are thread safe.

  • Method Details

    • createAnnotation

      IAnnotation createAnnotation(String name) throws Exception
      Creates an annotation. This does not create any user interface for the annotation. You can then call methods on the annotation. Use addAnnotation(...) and removeAnnotation(...) to control if the selection is active on the graph.
      Parameters:
      name -
      regionType -
      Returns:
      Throws:
      Exception - if name exists already.

    • addAnnotation

      void addAnnotation(IAnnotation region)
      Add an annotation to the graph.
      Parameters:
      region -

    • removeAnnotation

      void removeAnnotation(IAnnotation region)
      Remove an annotation to the graph.
      Parameters:
      region -

    • getAnnotation

      IAnnotation getAnnotation(String name)
      Get an annotation by name.
      Parameters:
      name -
      Returns:

    • clearAnnotations

      void clearAnnotations()
      Remove all annotations

    • renameAnnotation

      void renameAnnotation(IAnnotation annotation, String name)
      Renames the annotation; better than calling setName on the IAnnotation as the collection of annotations is updated properly. No event will be fired.