Class SpreadSheetRowLinePaintlet

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, AntiAliasingSupporter, Paintlet, PaintletWithMarkers, Serializable

    public class SpreadSheetRowLinePaintlet
    extends AbstractSpreadSheetRowPaintlet
    implements AntiAliasingSupporter, PaintletWithMarkers
    Paintlet for generating a line plot for Instance objects.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -stroke-thickness <float> (property: strokeThickness)
        The thickness of the stroke.
        default: 1.0
        minimum: 0.01
     
    -markers-extent <int> (property: markerExtent)
        The size of the markers in pixels.
        default: 7
        minimum: 0
     
    -markers-disabled <boolean> (property: markersDisabled)
        If set to true, the markers are disabled.
        default: false
     
    -always-show-markers <boolean> (property: alwaysShowMarkers)
        If set to true, the markers are always displayed, not just when zoomed in.
        default: true
     
    -anti-aliasing-enabled <boolean> (property: antiAliasingEnabled)
        If enabled, uses anti-aliasing for drawing lines.
        default: true
     
    Version:
    $Revision: 13440 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_MarkerExtent

        protected int m_MarkerExtent
        the maximum width/height of the shape to plot around the points (= data point marker), if there's enough space.
      • m_MarkersEnabled

        protected boolean m_MarkersEnabled
        indicates whether marker shapes are painted or not.
      • m_AlwaysShowMarkers

        protected boolean m_AlwaysShowMarkers
        whether to show markers all the time.
      • m_AntiAliasingEnabled

        protected boolean m_AntiAliasingEnabled
        whether anti-aliasing is enabled.
    • Constructor Detail

      • SpreadSheetRowLinePaintlet

        public SpreadSheetRowLinePaintlet()
    • Method Detail

      • getColor

        public Color getColor​(int index)
        Returns the color for the data with the given index.
        Parameters:
        index - the index of the chromatogram
        Returns:
        the color for the chromatogram
      • isMarkersDisabled

        public boolean isMarkersDisabled()
        Returns whether marker shapes are disabled.
        Specified by:
        isMarkersDisabled in interface PaintletWithMarkers
        Returns:
        true if marker shapes are disabled
      • setMarkersDisabled

        public void setMarkersDisabled​(boolean value)
        Sets whether to draw markers or not.
        Specified by:
        setMarkersDisabled in interface PaintletWithMarkers
        Parameters:
        value - if true then marker shapes won't be drawn
      • markersDisabledTipText

        public String markersDisabledTipText()
        Returns the tip text for this property.
        Specified by:
        markersDisabledTipText in interface PaintletWithMarkers
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getAlwaysShowMarkers

        public boolean getAlwaysShowMarkers()
        Returns whether marker shapes are always drawn.
        Specified by:
        getAlwaysShowMarkers in interface PaintletWithMarkers
        Returns:
        true if marker shapes are always drawn, not just when zoomed in
      • setAlwaysShowMarkers

        public void setAlwaysShowMarkers​(boolean value)
        Sets whether to always draw markers.
        Specified by:
        setAlwaysShowMarkers in interface PaintletWithMarkers
        Parameters:
        value - if true then marker are always drawn, not just when zoomed in
      • alwaysShowMarkersTipText

        public String alwaysShowMarkersTipText()
        Returns the tip text for this property.
        Specified by:
        alwaysShowMarkersTipText in interface PaintletWithMarkers
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setMarkerExtent

        public void setMarkerExtent​(int value)
        Sets the extent (width and height of the shape around the plotted point). 0 turns the plotting off. Should be an odd number for centering the shape.
        Specified by:
        setMarkerExtent in interface PaintletWithMarkers
        Parameters:
        value - the new extent
      • getMarkerExtent

        public int getMarkerExtent()
        Returns the current marker extent (which is the width and height of the shape).
        Specified by:
        getMarkerExtent in interface PaintletWithMarkers
        Returns:
        the current extent
      • markerExtentTipText

        public String markerExtentTipText()
        Returns the tip text for this property.
        Specified by:
        markerExtentTipText in interface PaintletWithMarkers
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setAntiAliasingEnabled

        public void setAntiAliasingEnabled​(boolean value)
        Sets whether to use anti-aliasing.
        Specified by:
        setAntiAliasingEnabled in interface AntiAliasingSupporter
        Parameters:
        value - if true then anti-aliasing is used
      • isAntiAliasingEnabled

        public boolean isAntiAliasingEnabled()
        Returns whether anti-aliasing is used.
        Specified by:
        isAntiAliasingEnabled in interface AntiAliasingSupporter
        Returns:
        true if anti-aliasing is used
      • antiAliasingEnabledTipText

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

        protected SpreadSheetRowLinePaintlet.MarkerShape getMarkerShape​(int index)
        Determines the shape to paint around the data points, based on the index of the data.
        Parameters:
        index - the index of the spectrum
        Returns:
        the marker shape