Package org.jfree.chart.axis

Class LogarithmicAxis

java.lang.Object

org.jfree.chart.axis.Axis

org.jfree.chart.axis.ValueAxis

org.jfree.chart.axis.NumberAxis

org.jfree.chart.axis.LogarithmicAxis

All Implemented Interfaces:

Serializable, Cloneable, org.jfree.util.PublicCloneable

public class LogarithmicAxis
extends NumberAxis

A numerical axis that uses a logarithmic scale.

Author:

Michael Duffy

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static double	LOG10_VALUE	Useful constant for log(10).
static double	SMALL_LOG_VALUE	Smallest arbitrarily-close-to-zero value allowed.

Fields inherited from class org.jfree.chart.axis.NumberAxis

DEFAULT_AUTO_RANGE_INCLUDES_ZERO, DEFAULT_AUTO_RANGE_STICKY_ZERO, DEFAULT_TICK_UNIT, DEFAULT_VERTICAL_TICK_LABELS

Fields inherited from class org.jfree.chart.axis.ValueAxis

DEFAULT_AUTO_RANGE, DEFAULT_AUTO_RANGE_MINIMUM_SIZE, DEFAULT_AUTO_TICK_UNIT_SELECTION, DEFAULT_INVERTED, DEFAULT_LOWER_BOUND, DEFAULT_LOWER_MARGIN, DEFAULT_RANGE, DEFAULT_UPPER_BOUND, DEFAULT_UPPER_MARGIN, MAXIMUM_TICK_COUNT

Fields inherited from class org.jfree.chart.axis.Axis

DEFAULT_AXIS_LABEL_FONT, DEFAULT_AXIS_LABEL_INSETS, DEFAULT_AXIS_LABEL_PAINT, DEFAULT_AXIS_LINE_PAINT, DEFAULT_AXIS_LINE_STROKE, DEFAULT_AXIS_VISIBLE, DEFAULT_TICK_LABEL_FONT, DEFAULT_TICK_LABEL_INSETS, DEFAULT_TICK_LABEL_PAINT, DEFAULT_TICK_LABELS_VISIBLE, DEFAULT_TICK_MARK_INSIDE_LENGTH, DEFAULT_TICK_MARK_OUTSIDE_LENGTH, DEFAULT_TICK_MARK_PAINT, DEFAULT_TICK_MARK_STROKE, DEFAULT_TICK_MARKS_VISIBLE

Constructor Summary

Constructors

Constructor	Description
LogarithmicAxis(String label)	Creates a new axis.

Method Summary

Modifier and Type	Method	Description
double	adjustedLog10(double val)	Returns an adjusted log10 value for graphing purposes.
void	autoAdjustRange()	Rescales the axis to ensure that all data is visible.
boolean	getAllowNegativesFlag()	Returns the 'allowNegativesFlag' flag; true to allow negative values in data, false to be able to plot positive values arbitrarily close to zero.
boolean	getExpTickLabelsFlag()	Returns the 'expTickLabelsFlag' flag.
boolean	getLog10TickLabelsFlag()	Returns the 'log10TickLabelsFlag' flag.
boolean	getStrictValuesFlag()	Returns the 'strictValuesFlag' flag; if true and 'allowNegativesFlag' is false then this axis will throw a runtime exception if any of its values are less than or equal to zero; if false then the axis will adjust for values less than or equal to zero as needed.
double	java2DToValue(double java2DValue, Rectangle2D plotArea, org.jfree.ui.RectangleEdge edge)	Converts a coordinate in Java2D space to the corresponding data value, assuming that the axis runs along one edge of the specified plotArea.
List	refreshTicks(Graphics2D g2, AxisState state, Rectangle2D drawArea, Rectangle2D dataArea, org.jfree.ui.RectangleEdge edge)	Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
List	refreshTicksHorizontal(Graphics2D g2, double cursor, Rectangle2D drawArea, Rectangle2D dataArea, org.jfree.ui.RectangleEdge edge)	Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
List	refreshTicksVertical(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, org.jfree.ui.RectangleEdge edge)	Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
void	setAllowNegativesFlag(boolean flgVal)	Sets the 'allowNegativesFlag' flag; true to allow negative values in data, false to be able to plot positive values arbitrarily close to zero.
void	setExpTickLabelsFlag(boolean flgVal)	Sets the 'expTickLabelsFlag' flag.
void	setLog10TickLabelsFlag(boolean flag)	Sets the 'log10TickLabelsFlag' flag.
void	setRange(Range range)	Overridden version that calls original and then sets up flag for log axis processing.
void	setStrictValuesFlag(boolean flgVal)	Sets the 'strictValuesFlag' flag; if true and 'allowNegativesFlag' is false then this axis will throw a runtime exception if any of its values are less than or equal to zero; if false then the axis will adjust for values less than or equal to zero as needed.
double	translateJava2DToValue(double java2DValue, Rectangle2D plotArea, org.jfree.ui.RectangleEdge edge)	Deprecated. Use java2DToValue().
double	translateValueToJava2D(double value, Rectangle2D plotArea, org.jfree.ui.RectangleEdge edge)	Deprecated. Use valueToJava2D().
double	valueToJava2D(double value, Rectangle2D plotArea, org.jfree.ui.RectangleEdge edge)	Converts a data value to a coordinate in Java2D space, assuming that the axis runs along one edge of the specified plotArea.

Methods inherited from class org.jfree.chart.axis.NumberAxis

autoRangeIncludesZero, autoRangeStickyZero, calculateHighestVisibleTickValue, calculateLowestVisibleTickValue, calculateVisibleTickCount, clone, configure, createIntegerTickUnits, createIntegerTickUnits, createStandardTickUnits, createStandardTickUnits, draw, equals, getDecimalFormat, getMarkerBand, getNumberFormatOverride, getTickUnit, setAutoRangeIncludesZero, setAutoRangeStickyZero, setMarkerBand, setNumberFormatOverride, setTickUnit, setTickUnit, stringReplace

Methods inherited from class org.jfree.chart.axis.ValueAxis

centerRange, getAutoRangeMinimumSize, getDownArrow, getFixedAutoRange, getLeftArrow, getLowerBound, getLowerMargin, getMaximumAxisValue, getMinimumAxisValue, getRange, getRightArrow, getStandardTickUnits, getUpArrow, getUpperBound, getUpperMargin, isAutoRange, isAutoTickUnitSelection, isInverted, isNegativeArrowVisible, isPositiveArrowVisible, isVerticalTickLabels, reserveSpace, resizeRange, resizeRange, setAutoRange, setAutoRangeMinimumSize, setAutoRangeMinimumSize, setAutoTickUnitSelection, setAutoTickUnitSelection, setDownArrow, setFixedAutoRange, setInverted, setLeftArrow, setLowerBound, setLowerMargin, setMaximumAxisValue, setMinimumAxisValue, setNegativeArrowVisible, setPositiveArrowVisible, setRange, setRange, setRangeAboutValue, setRangeWithMargins, setRangeWithMargins, setRangeWithMargins, setRightArrow, setStandardTickUnits, setUpArrow, setUpperBound, setUpperMargin, setVerticalTickLabels, translateJava2DtoValue, zoomRange

Methods inherited from class org.jfree.chart.axis.Axis

addChangeListener, getAxisLinePaint, getAxisLineStroke, getFixedDimension, getLabel, getLabelAngle, getLabelFont, getLabelInsets, getLabelPaint, getPlot, getTickLabelFont, getTickLabelInsets, getTickLabelPaint, getTickMarkInsideLength, getTickMarkOutsideLength, getTickMarkPaint, getTickMarkStroke, isAxisLineVisible, isTickLabelsVisible, isTickMarksVisible, isVisible, removeChangeListener, setAxisLinePaint, setAxisLineStroke, setAxisLineVisible, setFixedDimension, setLabel, setLabelAngle, setLabelFont, setLabelInsets, setLabelPaint, setPlot, setTickLabelFont, setTickLabelInsets, setTickLabelPaint, setTickLabelsVisible, setTickMarkInsideLength, setTickMarkOutsideLength, setTickMarkPaint, setTickMarkStroke, setTickMarksVisible, setVisible

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG10_VALUE

public static final double LOG10_VALUE

Useful constant for log(10).

SMALL_LOG_VALUE

public static final double SMALL_LOG_VALUE

Smallest arbitrarily-close-to-zero value allowed.

See Also:

Constant Field Values

Constructor Details

LogarithmicAxis

public LogarithmicAxis(String label)

Creates a new axis.

Parameters:

label - the axis label.

Method Details

setAllowNegativesFlag

public void setAllowNegativesFlag(boolean flgVal)

Sets the 'allowNegativesFlag' flag; true to allow negative values in data, false to be able to plot positive values arbitrarily close to zero.

Parameters:

flgVal - the new value of the flag.

getAllowNegativesFlag

public boolean getAllowNegativesFlag()

Returns the 'allowNegativesFlag' flag; true to allow negative values in data, false to be able to plot positive values arbitrarily close to zero.

Returns:

the flag.

setStrictValuesFlag

public void setStrictValuesFlag(boolean flgVal)

Sets the 'strictValuesFlag' flag; if true and 'allowNegativesFlag' is false then this axis will throw a runtime exception if any of its values are less than or equal to zero; if false then the axis will adjust for values less than or equal to zero as needed.

Parameters:

flgVal - true for strict enforcement.

getStrictValuesFlag

public boolean getStrictValuesFlag()

Returns the 'strictValuesFlag' flag; if true and 'allowNegativesFlag' is false then this axis will throw a runtime exception if any of its values are less than or equal to zero; if false then the axis will adjust for values less than or equal to zero as needed.

Returns:

true if strict enforcement is enabled.

setExpTickLabelsFlag

public void setExpTickLabelsFlag(boolean flgVal)

Sets the 'expTickLabelsFlag' flag. If the 'log10TickLabelsFlag' is false then this will set whether or not "1e#"-style tick labels are used. The default is to use "1e#"-style tick labels.

Parameters:

flgVal - true for "1e#"-style tick labels, false for log10 or regular numeric tick labels.

getExpTickLabelsFlag

public boolean getExpTickLabelsFlag()

Returns the 'expTickLabelsFlag' flag.

Returns:

true for "1e#"-style tick labels, false for log10 or regular numeric tick labels.

setLog10TickLabelsFlag

public void setLog10TickLabelsFlag(boolean flag)

Sets the 'log10TickLabelsFlag' flag. The default value is false.

Parameters:

flag - true for "10^n"-style tick labels, false for "1e#"-style or regular numeric tick labels.

getLog10TickLabelsFlag

public boolean getLog10TickLabelsFlag()

Returns the 'log10TickLabelsFlag' flag.

Returns:

true for "10^n"-style tick labels, false for "1e#"-style or regular numeric tick labels.

setRange

public void setRange(Range range)

Overridden version that calls original and then sets up flag for log axis processing.

Overrides:

setRange in class ValueAxis

Parameters:

range - the new range.

adjustedLog10

public double adjustedLog10(double val)

Returns an adjusted log10 value for graphing purposes. The first adjustment is that negative values are changed to positive during the calculations, and then the answer is negated at the end. The second is that, for values less than 10, an increasingly large (0 to 1) scaling factor is added such that at 0 the value is adjusted to 1, resulting in a returned result of 0.

Parameters:

val - value for which log10 should be calculated.

Returns:

an adjusted log₁₀(val).

autoAdjustRange

public void autoAdjustRange()

Rescales the axis to ensure that all data is visible.

valueToJava2D

public double valueToJava2D(double value,
Rectangle2D plotArea,
org.jfree.ui.RectangleEdge edge)

Converts a data value to a coordinate in Java2D space, assuming that the axis runs along one edge of the specified plotArea. Note that it is possible for the coordinate to fall outside the plotArea.

Overrides:

valueToJava2D in class NumberAxis

Parameters:

value - the data value.

plotArea - the area for plotting the data.

edge - the axis location.

Returns:

the Java2D coordinate.

java2DToValue

public double java2DToValue(double java2DValue,
Rectangle2D plotArea,
org.jfree.ui.RectangleEdge edge)

Converts a coordinate in Java2D space to the corresponding data value, assuming that the axis runs along one edge of the specified plotArea.

Overrides:

java2DToValue in class NumberAxis

Parameters:

java2DValue - the coordinate in Java2D space.

plotArea - the area in which the data is plotted.

edge - the axis location.

Returns:

the data value.

refreshTicks

public List refreshTicks(Graphics2D g2,
AxisState state,
Rectangle2D drawArea,
Rectangle2D dataArea,
org.jfree.ui.RectangleEdge edge)

Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).

Overrides:

refreshTicks in class NumberAxis

Parameters:

g2 - the graphics device.

state - the axis state.

drawArea - the area in which the plot and the axes should be drawn.

dataArea - the area in which the plot should be drawn.

edge - the location of the axis.

Returns:

a list of ticks.

refreshTicksHorizontal

public List refreshTicksHorizontal(Graphics2D g2,
double cursor,
Rectangle2D drawArea,
Rectangle2D dataArea,
org.jfree.ui.RectangleEdge edge)

Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).

Parameters:

g2 - the graphics device.

cursor - the cursor position.

drawArea - the area in which the plot and the axes should be drawn.

dataArea - the area in which the plot should be drawn.

edge - the location of the axis.

Returns:

A list of ticks.

refreshTicksVertical

public List refreshTicksVertical(Graphics2D g2,
double cursor,
Rectangle2D plotArea,
Rectangle2D dataArea,
org.jfree.ui.RectangleEdge edge)

Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).

Parameters:

g2 - the graphics device.

cursor - the cursor position.

plotArea - the area in which the plot and the axes should be drawn.

dataArea - the area in which the plot should be drawn.

edge - the axis location.

Returns:

A list of ticks.

translateValueToJava2D

public double translateValueToJava2D(double value,
Rectangle2D plotArea,
org.jfree.ui.RectangleEdge edge)

Deprecated.

Use valueToJava2D().

Converts a data value to a coordinate in Java2D space, assuming that the axis runs along one edge of the specified plotArea. Note that it is possible for the coordinate to fall outside the plotArea.

Overrides:

translateValueToJava2D in class NumberAxis

Parameters:

value - the data value.

plotArea - the area for plotting the data.

edge - the axis location.

Returns:

the Java2D coordinate.

translateJava2DToValue

public double translateJava2DToValue(double java2DValue,
Rectangle2D plotArea,
org.jfree.ui.RectangleEdge edge)

Deprecated.

Use java2DToValue().

Converts a coordinate in Java2D space to the corresponding data value, assuming that the axis runs along one edge of the specified plotArea.

Overrides:

translateJava2DToValue in class NumberAxis

Parameters:

java2DValue - the coordinate in Java2D space.

plotArea - the area in which the data is plotted.

edge - the axis location.

Returns:

the data value.