Interface GraphDisplayProvider

  • All Superinterfaces:
    ExtensionPoint

    public interface GraphDisplayProvider
    extends ExtensionPoint
    Basic interface for objects that can display or otherwise consume a generic graph
    • Method Detail

      • getName

        java.lang.String getName()
        The name of this provider (for displaying as menu option when graphing)
        Returns:
        the name of this provider.
      • getGraphDisplay

        GraphDisplay getGraphDisplay​(boolean reuseGraph,
                                     TaskMonitor monitor)
                              throws GraphException
        Returns a GraphDisplay that can be used to "display" a graph
        Parameters:
        reuseGraph - if true, this provider will attempt to re-use an existing GraphDisplay
        monitor - the TaskMonitor that can be used to monitor and cancel the operation
        Returns:
        A GraphDisplay that can be used to display (or otherwise consume - e.g. export) the graph
        Throws:
        GraphException - thrown if there is a problem creating a GraphDisplay
      • initialize

        void initialize​(PluginTool tool,
                        Options options)
        Provides an opportunity for this provider to register and read tool options
        Parameters:
        tool - the tool hosting this display
        options - the tool options for graphing
      • optionsChanged

        void optionsChanged​(Options options)
        Called if the graph options change
        Parameters:
        options - the current tool options
      • dispose

        void dispose()
        Disposes this GraphDisplayProvider
      • getHelpLocation

        HelpLocation getHelpLocation()
        Gets the help location for this GraphDisplayProvider
        Returns:
        help location for this GraphDisplayProvider