Class DefaultTimeseriesYAxisPanelOptions
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.gui.visualization.core.AxisPanelOptions
-
- adams.gui.visualization.timeseries.AbstractTimeseriesYAxisPanelOptions
-
- adams.gui.visualization.timeseries.DefaultTimeseriesYAxisPanelOptions
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,PlotPanelAxisOptions
,TimeseriesYAxisPanelOptions
,Serializable
public class DefaultTimeseriesYAxisPanelOptions extends AbstractTimeseriesYAxisPanelOptions
Encapsulates options for the Y 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:
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class adams.gui.visualization.core.AxisPanelOptions
m_BottomMargin, m_CustomFormat, m_Label, m_LengthTicks, m_NthValueToShow, m_ShowGridLines, m_TickGenerator, m_TopMargin, m_Type, m_Width
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description DefaultTimeseriesYAxisPanelOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
globalInfo()
Returns a string describing the object.-
Methods inherited from class adams.gui.visualization.core.AxisPanelOptions
bottomMarginTipText, configure, customFormatTipText, defineOptions, getBottomMargin, getCustomFormat, getLabel, getLengthTicks, getNthValueToShow, getShowGridLines, getTickGenerator, getTopMargin, getType, getWidth, labelTipText, lengthTicksTipText, nthValueToShowTipText, setBottomMargin, setCustomFormat, setLabel, setLengthTicks, setNthValueToShow, setShowGridLines, setTickGenerator, setTopMargin, setType, setWidth, showGridLinesTipText, tickGeneratorTipText, topMarginTipText, typeTipText, widthTipText
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.Destroyable
destroy
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine
-
Methods inherited from interface adams.gui.visualization.core.PlotPanelAxisOptions
configure
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Overrides:
globalInfo
in classAxisPanelOptions
- Returns:
- a description suitable for displaying in the gui
-
-