Package adams.gui.visualization.timeseries

Class DefaultTimeseriesXAxisPanelOptions

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, PlotPanelAxisOptions, TimeseriesXAxisPanelOptions, Serializable
    public class DefaultTimeseriesXAxisPanelOptions
extends AbstractTimeseriesXAxisPanelOptions
    Encapsulates options for the X axis in a timeseries plot. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -label <java.lang.String> (property: label)
    The label of the axis.
    default:
 
    -type <ABSOLUTE|PERCENTAGE|LOG10_ABSOLUTE|LOG10_PERCENTAGE|LOG_ABSOLUTE|LOG_PERCENTAGE|DATE|TIME|DATETIME> (property: type)
    The type of the axis.
    default: ABSOLUTE
 
    -hide-grid-lines <boolean> (property: showGridLines)
    If enabled, grid lines are plotted as well.
    default: true
 
    -tick-generator <adams.gui.visualization.core.axis.TickGenerator> (property: tickGenerator)
    Algorithm for generating the tick positions.
    default: adams.gui.visualization.core.axis.FancyTickGenerator
 
    -nth-value <int> (property: nthValueToShow)
    The count of ticks a value is shown, i.e., '3' means every third tick: 1,
     4, 7, ...
    default: 5
    minimum: 0
 
    -length-ticks <int> (property: lengthTicks)
    The length in pixels of the ticks to display.
    default: 4
    minimum: 1
 
    -width <int> (property: width)
    The width/height of the axis (>= 5).
    default: 20
    minimum: 5
 
    -top-margin <double> (property: topMargin)
    The factor for an extra margin on the top/left (eg 0.05 = 5%).
    default: 0.0
    minimum: 0.0
 
    -bottom-margin <double> (property: bottomMargin)
    The factor for an extra margin on the bottom/right (eg 0.05 = 5%).
    default: 0.0
    minimum: 0.0
 
    -custom-format <adams.data.DecimalFormatString> (property: customFormat)
    The custom format for displaying the tick labels on the axis.
    default:
 
    -periodicity <NONE|YEARLY|QUARTERLY|MONTHLY|WEEKLY|DAILY|HALF_DAILY|HOURLY|HALF_HOURLY|PER_MINUTE> (property: periodicity)
    The type of periodicity to use for the background.
    default: NONE
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Periodicity

        protected PeriodicityType m_Periodicity
        the periodicity to use.

    • Constructor Detail

      • DefaultTimeseriesXAxisPanelOptions

        public DefaultTimeseriesXAxisPanelOptions()

    • Method Detail

      • setPeriodicity

        public void setPeriodicity​(PeriodicityType value)
        Sets the type of periodicity to use for the background.
        Parameters:
        value - the type

      • getPeriodicity

        public PeriodicityType getPeriodicity()
        Returns the type of periodicity to use for the background.
        Returns:
        the type

      • periodicityTipText

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