Package adams.gui.tools.spreadsheetviewer.chart

Class GenericPlot

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ColorProviderHandler, Serializable
    public class GenericPlot
extends AbstractRowBasedChartGenerator
implements ColorProviderHandler
    Flexible chart generator. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -width <int> (property: width)
    The width of the chart dialog.
    default: 800
    minimum: -1
 
    -height <int> (property: height)
    The height of the chart dialog.
    default: 600
    minimum: -1
 
    -row-finder <adams.data.spreadsheet.rowfinder.RowFinder> (property: rowFinder)
    The row finder to use for restricting the rows used for the chart.
    default: adams.data.spreadsheet.rowfinder.ByIndex
 
    -generator <adams.flow.transformer.plotgenerator.AbstractPlotGenerator> (property: generator)
    The generator for producing the plot containers.
    default: adams.flow.transformer.plotgenerator.XYPlotGenerator
 
    -paintlet <adams.gui.visualization.sequence.XYSequencePaintlet> (property: paintlet)
    The paintlet to use for the data.
    default: adams.gui.visualization.sequence.LinePaintlet
 
    -color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider to use.
    default: adams.gui.visualization.core.DefaultColorProvider
 
    -x-tick-generator <adams.gui.visualization.core.axis.TickGenerator> (property: XTickGenerator)
    The tick generator to use for the X axis.
    default: adams.gui.visualization.core.axis.SimpleTickGenerator
 
    -y-tick-generator <adams.gui.visualization.core.axis.TickGenerator> (property: YTickGenerator)
    The tick generator to use for the Y axis.
    default: adams.gui.visualization.core.axis.SimpleTickGenerator
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Paintlet

        protected XYSequencePaintlet m_Paintlet
        the paintlet to use for painting the XY data.

      • m_ColorProvider

        protected ColorProvider m_ColorProvider
        the color provider to use.

      • m_XTickGenerator

        protected TickGenerator m_XTickGenerator
        the tick generator for the X axis.

      • m_YTickGenerator

        protected TickGenerator m_YTickGenerator
        the tick generator for the Y axis.

    • Constructor Detail

      • GenericPlot

        public GenericPlot()

    • Method Detail

      • setGenerator

        public void setGenerator​(AbstractPlotGenerator value)
        Sets the generator for producing the plot containers.
        Parameters:
        value - the generator

      • getGenerator

        public AbstractPlotGenerator getGenerator()
        Returns the generator for producing the plot containers.
        Returns:
        the generator

      • generatorTipText

        public String generatorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setPaintlet

        public void setPaintlet​(XYSequencePaintlet value)
        Sets the paintlet to use.
        Parameters:
        value - the paintlet

      • getPaintlet

        public XYSequencePaintlet getPaintlet()
        Returns the paintlet to use.
        Returns:
        the paintlet

      • paintletTipText

        public String paintletTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • colorProviderTipText

        public String colorProviderTipText()
        Returns the tip text for this property.
        Specified by:
        colorProviderTipText in interface ColorProviderHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setXTickGenerator

        public void setXTickGenerator​(TickGenerator value)
        Sets the tick generator for the X axis.
        Parameters:
        value - the tick generator

      • getXTickGenerator

        public TickGenerator getXTickGenerator()
        Returns the tick generator for the X axis.
        Returns:
        the tick generator

      • XTickGeneratorTipText

        public String XTickGeneratorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setYTickGenerator

        public void setYTickGenerator​(TickGenerator value)
        Sets the tick generator for the X axis.
        Parameters:
        value - the tick generator

      • getYTickGenerator

        public TickGenerator getYTickGenerator()
        Returns the tick generator for the Y axis.
        Returns:
        the tick generator

      • YTickGeneratorTipText

        public String YTickGeneratorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • addChartGeneration

        protected void addChartGeneration​(Flow flow,
                                  String name,
                                  SpreadSheet sheet)
        Adds the chart generation to the flow. The flow already contains forwarding of spreadsheet and selecting subset of rows.
        Overrides:
        addChartGeneration in class AbstractRowBasedChartGenerator
        Parameters:
        flow - the flow to extend
        name - the name of the tab/sheet
        sheet - the spreadsheet to generate the flow for