ValueAxis

java.lang.Object
- Region
- - javafx.scene.chart.Axis<T>
  - - javafx.scene.chart.ValueAxis<T>

Direct Known Subclasses:

NumberAxis
```
public abstract class ValueAxis<T extends java.lang.Number>
extends Axis<T>
```
An axis whose data is defined as Numbers. It can also draw minor tick-marks between the major ones.

Since:

JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`DoubleProperty`	`lowerBound` The value for the lower bound of this axis (minimum value).
`IntegerProperty`	`minorTickCount` The number of minor tick divisions to be displayed between each major tick mark.
`DoubleProperty`	`minorTickLength` The length of minor tick mark lines.
`BooleanProperty`	`minorTickVisible` true if minor tick marks should be displayed
`ReadOnlyDoubleProperty`	`scale` The scale factor from data units to visual units
`<any>`	`tickLabelFormatter` StringConverter used to format tick mark labels.
`DoubleProperty`	`upperBound` The value for the upper bound of this axis (maximum value).

Properties inherited from class javafx.scene.chart.Axis
animatedProperty, autoRangingProperty, labelProperty, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarkVisibleProperty

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class ValueAxis.StyleableProperties
- Nested classes/interfaces inherited from class javafx.scene.chart.Axis
  Axis.TickMark<T>

Nested Classes
Modifier and Type	Class and Description
`private static class`	`ValueAxis.StyleableProperties`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DoubleProperty`	`currentLowerBound` The current value for the lowerBound of this axis (minimum value).
`(package private) double`	`dataMaxValue` This is the maximum current data value and it is used while auto ranging.
`(package private) double`	`dataMinValue` This is the minimum current data value and it is used while auto ranging.
`private DoubleProperty`	`lowerBound` The value for the lower bound of this axis (minimum value).
`private IntegerProperty`	`minorTickCount` The number of minor tick divisions to be displayed between each major tick mark.
`private DoubleProperty`	`minorTickLength` The length of minor tick mark lines.
`private boolean`	`minorTickMarksDirty`
`private java.util.List<T>`	`minorTickMarkValues` List of the values at which there are minor ticks
`private Path`	`minorTickPath`
`private BooleanProperty`	`minorTickVisible` true if minor tick marks should be displayed
`private double`	`offset`
`private ReadOnlyDoubleWrapper`	`scale` The scale factor from data units to visual units
`private <any>`	`tickLabelFormatter` StringConverter used to format tick mark labels.
`private DoubleProperty`	`upperBound` The value for the upper bound of this axis (maximum value).

Fields inherited from class javafx.scene.chart.Axis
measure, measureInvalid, rangeValid, tickLabelsVisibleInvalid

Constructor Summary

Constructors
Constructor and Description
`ValueAxis()` Creates a auto-ranging ValueAxis.
`ValueAxis(double lowerBound, double upperBound)` Creates a non-auto-ranging ValueAxis with the given lower and upper bound.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`autoRange(double length)` This calculates the upper and lower bound based on the data provided to invalidateRange() method.
`protected java.lang.Object`	`autoRange(double minValue, double maxValue, double length, double labelSize)` Called to set the upper and lower bound and anything else that needs to be auto-ranged.
`protected abstract java.util.List<T>`	`calculateMinorTickMarks()` Calculates a list of the data values for every minor tick mark
`protected double`	`calculateNewScale(double length, double lowerBound, double upperBound)` Calculates new scale for this axis.
`static java.util.List<<any>>`	`getClassCssMetaData()`
`java.util.List<<any>>`	`getCssMetaData()`
`double`	`getDisplayPosition(T value)` Gets the display position along this axis for a given value.
`double`	`getLowerBound()` Gets the value of the property lowerBound.
`int`	`getMinorTickCount()` Gets the value of the property minorTickCount.
`double`	`getMinorTickLength()` Gets the value of the property minorTickLength.
`double`	`getScale()` Gets the value of the property scale.
`<any>`	`getTickLabelFormatter()` Gets the value of the property tickLabelFormatter.
`double`	`getUpperBound()` Gets the value of the property upperBound.
`T`	`getValueForDisplay(double displayPosition)` Gets the data value for the given display position on this axis.
`double`	`getZeroPosition()` Gets the display position of the zero line along this axis.
`void`	`invalidateRange(java.util.List<T> data)` Called when the data has changed and the range may not be valid anymore.
`boolean`	`isMinorTickVisible()` Gets the value of the property minorTickVisible.
`boolean`	`isValueOnAxis(T value)` Checks if the given value is plottable on this axis
`protected void`	`layoutChildren()` Invoked during the layout pass to layout this axis and all its content.
`DoubleProperty`	`lowerBoundProperty()` The value for the lower bound of this axis (minimum value).
`IntegerProperty`	`minorTickCountProperty()` The number of minor tick divisions to be displayed between each major tick mark.
`DoubleProperty`	`minorTickLengthProperty()` The length of minor tick mark lines.
`BooleanProperty`	`minorTickVisibleProperty()` true if minor tick marks should be displayed
`ReadOnlyDoubleProperty`	`scaleProperty()` The scale factor from data units to visual units
`(package private) ReadOnlyDoubleWrapper`	`scalePropertyImpl()`
`void`	`setLowerBound(double value)` Sets the value of the property lowerBound.
`void`	`setMinorTickCount(int value)` Sets the value of the property minorTickCount.
`void`	`setMinorTickLength(double value)` Sets the value of the property minorTickLength.
`void`	`setMinorTickVisible(boolean value)` Sets the value of the property minorTickVisible.
`protected void`	`setScale(double scale)` Sets the value of the property scale.
`void`	`setTickLabelFormatter(<any> value)` Sets the value of the property tickLabelFormatter.
`void`	`setUpperBound(double value)` Sets the value of the property upperBound.
`<any>`	`tickLabelFormatterProperty()` StringConverter used to format tick mark labels.
`protected void`	`tickMarksUpdated()` Called during layout if the tickmarks have been updated, allowing subclasses to do anything they need to in reaction.
`double`	`toNumericValue(T value)` All axis values must be representable by some numeric value.
`T`	`toRealValue(double value)` All axis values must be representable by some numeric value.
`private void`	`updateMinorTickPath(Side side, double length)`
`DoubleProperty`	`upperBoundProperty()` The value for the upper bound of this axis (maximum value).

Methods inherited from class javafx.scene.chart.Axis
animatedProperty, autoRangingProperty, calculateTickValues, computePrefHeight, computePrefWidth, getAnimated, getEffectiveSide, getEffectiveTickLabelRotation, getLabel, getRange, getSide, getTickLabelFill, getTickLabelFont, getTickLabelGap, getTickLabelRotation, getTickLength, getTickMarkLabel, getTickMarks, invalidateRange, isAutoRanging, isRangeValid, isTickLabelsVisible, isTickMarkVisible, labelProperty, measureTickMarkLabelSize, measureTickMarkSize, measureTickMarkSize, requestAxisLayout, requestLayout, setAnimated, setAutoRanging, setEffectiveOrientation, setEffectiveTickLabelRotation, setLabel, setRange, setSide, setTickLabelFill, setTickLabelFont, setTickLabelGap, setTickLabelRotation, setTickLabelsVisible, setTickLength, setTickMarkVisible, shouldAnimate, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarkVisibleProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - minorTickVisible
```
public final BooleanProperty minorTickVisibleProperty
```
    true if minor tick marks should be displayed
    
    See Also:
    
    isMinorTickVisible(), setMinorTickVisible(boolean)
  - scale
```
public final ReadOnlyDoubleProperty scaleProperty
```
    The scale factor from data units to visual units
    
    See Also:
    
    getScale(), setScale(double)
  - upperBound
```
public final DoubleProperty upperBoundProperty
```
    The value for the upper bound of this axis (maximum value). This is automatically set if auto ranging is on.
    
    See Also:
    
    getUpperBound(), setUpperBound(double)
  - lowerBound
```
public final DoubleProperty lowerBoundProperty
```
    The value for the lower bound of this axis (minimum value). This is automatically set if auto ranging is on.
    
    See Also:
    
    getLowerBound(), setLowerBound(double)
  - tickLabelFormatter
```
public final <any> tickLabelFormatterProperty
```
    StringConverter used to format tick mark labels. If null a default will be used
    
    See Also:
    
    getTickLabelFormatter(), #setTickLabelFormatter()
  - minorTickLength
```
public final DoubleProperty minorTickLengthProperty
```
    The length of minor tick mark lines. Set to 0 to not display minor tick marks.
    
    See Also:
    
    getMinorTickLength(), setMinorTickLength(double)
  - minorTickCount
```
public final IntegerProperty minorTickCountProperty
```
    The number of minor tick divisions to be displayed between each major tick mark. The number of actual minor tick marks will be one less than this.
    
    See Also:
    
    getMinorTickCount(), setMinorTickCount(int)
- Field Detail
  - minorTickPath
```
private final Path minorTickPath
```
  - offset
```
private double offset
```
  - dataMinValue
```
double dataMinValue
```
    This is the minimum current data value and it is used while auto ranging. Package private solely for test purposes
  - dataMaxValue
```
double dataMaxValue
```
    This is the maximum current data value and it is used while auto ranging. Package private solely for test purposes
  - minorTickMarkValues
```
private java.util.List<T extends java.lang.Number> minorTickMarkValues
```
    List of the values at which there are minor ticks
  - minorTickMarksDirty
```
private boolean minorTickMarksDirty
```
  - currentLowerBound
```
protected final DoubleProperty currentLowerBound
```
    The current value for the lowerBound of this axis (minimum value). This may be the same as lowerBound or different. It is used by NumberAxis to animate the lowerBound from the old value to the new value.
  - minorTickVisible
```
private BooleanProperty minorTickVisible
```
    true if minor tick marks should be displayed
  - scale
```
private ReadOnlyDoubleWrapper scale
```
    The scale factor from data units to visual units
  - upperBound
```
private DoubleProperty upperBound
```
    The value for the upper bound of this axis (maximum value). This is automatically set if auto ranging is on.
  - lowerBound
```
private DoubleProperty lowerBound
```
    The value for the lower bound of this axis (minimum value). This is automatically set if auto ranging is on.
  - tickLabelFormatter
```
private final <any> tickLabelFormatter
```
    StringConverter used to format tick mark labels. If null a default will be used
  - minorTickLength
```
private DoubleProperty minorTickLength
```
    The length of minor tick mark lines. Set to 0 to not display minor tick marks.
  - minorTickCount
```
private IntegerProperty minorTickCount
```
    The number of minor tick divisions to be displayed between each major tick mark. The number of actual minor tick marks will be one less than this.
- Constructor Detail
  - ValueAxis
```
public ValueAxis()
```
    Creates a auto-ranging ValueAxis.
  - ValueAxis
```
public ValueAxis(double lowerBound,
                 double upperBound)
```
    Creates a non-auto-ranging ValueAxis with the given lower and upper bound.
    
    Parameters:
    
    lowerBound - The lower bound for this axis, i.e. min plottable value
    
    upperBound - The upper bound for this axis, i.e. max plottable value
- Method Detail
  - isMinorTickVisible
```
public final boolean isMinorTickVisible()
```
    Gets the value of the property minorTickVisible.
  - setMinorTickVisible
```
public final void setMinorTickVisible(boolean value)
```
    Sets the value of the property minorTickVisible.
  - minorTickVisibleProperty
```
public final BooleanProperty minorTickVisibleProperty()
```
    true if minor tick marks should be displayed
    
    See Also:
    
    isMinorTickVisible(), setMinorTickVisible(boolean)
  - getScale
```
public final double getScale()
```
    Gets the value of the property scale.
  - setScale
```
protected final void setScale(double scale)
```
    Sets the value of the property scale.
  - scaleProperty
```
public final ReadOnlyDoubleProperty scaleProperty()
```
    The scale factor from data units to visual units
    
    See Also:
    
    getScale(), setScale(double)
  - scalePropertyImpl
```
ReadOnlyDoubleWrapper scalePropertyImpl()
```
  - getUpperBound
```
public final double getUpperBound()
```
    Gets the value of the property upperBound.
  - setUpperBound
```
public final void setUpperBound(double value)
```
    Sets the value of the property upperBound.
  - upperBoundProperty
```
public final DoubleProperty upperBoundProperty()
```
    The value for the upper bound of this axis (maximum value). This is automatically set if auto ranging is on.
    
    See Also:
    
    getUpperBound(), setUpperBound(double)
  - getLowerBound
```
public final double getLowerBound()
```
    Gets the value of the property lowerBound.
  - setLowerBound
```
public final void setLowerBound(double value)
```
    Sets the value of the property lowerBound.
  - lowerBoundProperty
```
public final DoubleProperty lowerBoundProperty()
```
    The value for the lower bound of this axis (minimum value). This is automatically set if auto ranging is on.
    
    See Also:
    
    getLowerBound(), setLowerBound(double)
  - getTickLabelFormatter
```
public final <any> getTickLabelFormatter()
```
    Gets the value of the property tickLabelFormatter.
  - setTickLabelFormatter
```
public final void setTickLabelFormatter(<any> value)
```
    Sets the value of the property tickLabelFormatter.
  - tickLabelFormatterProperty
```
public final <any> tickLabelFormatterProperty()
```
    StringConverter used to format tick mark labels. If null a default will be used
    
    See Also:
    
    getTickLabelFormatter(), #setTickLabelFormatter()
  - getMinorTickLength
```
public final double getMinorTickLength()
```
    Gets the value of the property minorTickLength.
  - setMinorTickLength
```
public final void setMinorTickLength(double value)
```
    Sets the value of the property minorTickLength.
  - minorTickLengthProperty
```
public final DoubleProperty minorTickLengthProperty()
```
    The length of minor tick mark lines. Set to 0 to not display minor tick marks.
    
    See Also:
    
    getMinorTickLength(), setMinorTickLength(double)
  - getMinorTickCount
```
public final int getMinorTickCount()
```
    Gets the value of the property minorTickCount.
  - setMinorTickCount
```
public final void setMinorTickCount(int value)
```
    Sets the value of the property minorTickCount.
  - minorTickCountProperty
```
public final IntegerProperty minorTickCountProperty()
```
    The number of minor tick divisions to be displayed between each major tick mark. The number of actual minor tick marks will be one less than this.
    
    See Also:
    
    getMinorTickCount(), setMinorTickCount(int)
  - autoRange
```
protected final java.lang.Object autoRange(double length)
```
    This calculates the upper and lower bound based on the data provided to invalidateRange() method. This must not affect the state of the axis. Any results of the auto-ranging should be returned in the range object. This will we passed to setRange() if it has been decided to adopt this range for this axis.
    
    Specified by:
    
    autoRange in class Axis<T extends java.lang.Number>
    
    Parameters:
    
    length - The length of the axis in screen coordinates
    
    Returns:
    
    Range information, this is implementation dependent
  - calculateNewScale
```
protected final double calculateNewScale(double length,
                                         double lowerBound,
                                         double upperBound)
```
    Calculates new scale for this axis. This should not affect any properties of this axis.
    
    Parameters:
    
    length - The display length of the axis
    
    lowerBound - The lower bound value
    
    upperBound - The upper bound value
    
    Returns:
    
    new scale to fit the range from lower bound to upper bound in the given display length
  - autoRange
```
protected java.lang.Object autoRange(double minValue,
                                     double maxValue,
                                     double length,
                                     double labelSize)
```
    Called to set the upper and lower bound and anything else that needs to be auto-ranged. This must not affect the state of the axis. Any results of the auto-ranging should be returned in the range object. This will we passed to setRange() if it has been decided to adopt this range for this axis.
    
    Parameters:
    
    minValue - The min data value that needs to be plotted on this axis
    
    maxValue - The max data value that needs to be plotted on this axis
    
    length - The length of the axis in display coordinates
    
    labelSize - The approximate average size a label takes along the axis
    
    Returns:
    
    The calculated range
  - calculateMinorTickMarks
```
protected abstract java.util.List<T> calculateMinorTickMarks()
```
    Calculates a list of the data values for every minor tick mark
    
    Returns:
    
    List of data values where to draw minor tick marks
  - tickMarksUpdated
```
protected void tickMarksUpdated()
```
    Called during layout if the tickmarks have been updated, allowing subclasses to do anything they need to in reaction.
    
    Overrides:
    
    tickMarksUpdated in class Axis<T extends java.lang.Number>
  - layoutChildren
```
protected void layoutChildren()
```
    Invoked during the layout pass to layout this axis and all its content.
    
    Overrides:
    
    layoutChildren in class Axis<T extends java.lang.Number>
  - updateMinorTickPath
```
private void updateMinorTickPath(Side side,
                                 double length)
```
  - invalidateRange
```
public void invalidateRange(java.util.List<T> data)
```
    Called when the data has changed and the range may not be valid anymore. This is only called by the chart if isAutoRanging() returns true. If we are auto ranging it will cause layout to be requested and auto ranging to happen on next layout pass.
    
    Overrides:
    
    invalidateRange in class Axis<T extends java.lang.Number>
    
    Parameters:
    
    data - The current set of all data that needs to be plotted on this axis
  - getDisplayPosition
```
public double getDisplayPosition(T value)
```
    Gets the display position along this axis for a given value. If the value is not in the current range, the returned value will be an extrapolation of the display position.
    
    Specified by:
    
    getDisplayPosition in class Axis<T extends java.lang.Number>
    
    Parameters:
    
    value - The data value to work out display position for
    
    Returns:
    
    display position
  - getValueForDisplay
```
public T getValueForDisplay(double displayPosition)
```
    Gets the data value for the given display position on this axis. If the axis is a CategoryAxis this will be the nearest value.
    
    Specified by:
    
    getValueForDisplay in class Axis<T extends java.lang.Number>
    
    Parameters:
    
    displayPosition - A pixel position on this axis
    
    Returns:
    
    the nearest data value to the given pixel position or null if not on axis;
  - getZeroPosition
```
public double getZeroPosition()
```
    Gets the display position of the zero line along this axis.
    
    Specified by:
    
    getZeroPosition in class Axis<T extends java.lang.Number>
    
    Returns:
    
    display position or Double.NaN if zero is not in current range;
  - isValueOnAxis
```
public boolean isValueOnAxis(T value)
```
    Checks if the given value is plottable on this axis
    
    Specified by:
    
    isValueOnAxis in class Axis<T extends java.lang.Number>
    
    Parameters:
    
    value - The value to check if its on axis
    
    Returns:
    
    true if the given value is plottable on this axis
  - toNumericValue
```
public double toNumericValue(T value)
```
    All axis values must be representable by some numeric value. This gets the numeric value for a given data value.
    
    Specified by:
    
    toNumericValue in class Axis<T extends java.lang.Number>
    
    Parameters:
    
    value - The data value to convert
    
    Returns:
    
    Numeric value for the given data value
  - toRealValue
```
public T toRealValue(double value)
```
    All axis values must be representable by some numeric value. This gets the data value for a given numeric value.
    
    Specified by:
    
    toRealValue in class Axis<T extends java.lang.Number>
    
    Parameters:
    
    value - The numeric value to convert
    
    Returns:
    
    Data value for given numeric value
  - getClassCssMetaData
```
public static java.util.List<<any>> getClassCssMetaData()
```
    Returns:
    
    The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
    
    Since:
    
    JavaFX 8.0
  - getCssMetaData
```
public java.util.List<<any>> getCssMetaData()
```
    Overrides:
    
    getCssMetaData in class Axis<T extends java.lang.Number>
    
    Since:
    
    JavaFX 8.0

Class ValueAxis<T extends java.lang.Number>

Property Summary

Properties inherited from class javafx.scene.chart.Axis

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.chart.Axis

Field Summary

Fields inherited from class javafx.scene.chart.Axis

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.chart.Axis

Methods inherited from class java.lang.Object

Property Detail

minorTickVisible

scale

upperBound

lowerBound

tickLabelFormatter

minorTickLength

minorTickCount

Field Detail

minorTickPath

offset

dataMinValue

dataMaxValue

minorTickMarkValues

minorTickMarksDirty

currentLowerBound

minorTickVisible

scale

upperBound

lowerBound

tickLabelFormatter

minorTickLength

minorTickCount

Constructor Detail

ValueAxis

ValueAxis

Method Detail

isMinorTickVisible

setMinorTickVisible

minorTickVisibleProperty

getScale

setScale

scaleProperty

scalePropertyImpl

getUpperBound

setUpperBound

upperBoundProperty

getLowerBound

setLowerBound

lowerBoundProperty

getTickLabelFormatter

setTickLabelFormatter

tickLabelFormatterProperty

getMinorTickLength

setMinorTickLength

minorTickLengthProperty

getMinorTickCount

setMinorTickCount

minorTickCountProperty

autoRange

calculateNewScale

autoRange

calculateMinorTickMarks

tickMarksUpdated

layoutChildren

updateMinorTickPath

invalidateRange

getDisplayPosition

getValueForDisplay

getZeroPosition

isValueOnAxis

toNumericValue

toRealValue

getClassCssMetaData

getCssMetaData