javafx.scene.chart

Class ValueAxis<T extends java.lang.Number>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.chart.Axis<T>

javafx.scene.chart.ValueAxis<T>

All Implemented Interfaces:

EventTarget

Direct Known Subclasses:

NumberAxis

public abstract class ValueAxis<T extends java.lang.Number>
extends Axis<T>

A axis who's data is defined as Numbers. It can also draw minor tick-marks between the major ones.

Property Summary

Properties

Type	Property and Description
DoubleProperty	lowerBound The value for the lower bound of this axis, ie min 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
ObjectProperty<StringConverter<T>>	tickLabelFormatter StringConverter used to format tick mark labels.
DoubleProperty	upperBound The value for the upper bound of this axis, ie max value.

Properties inherited from class javafx.scene.chart.Axis

animated, autoRanging, label, side, tickLabelFill, tickLabelFont, tickLabelGap, tickLabelRotation, tickLabelsVisible, tickLength, tickMarkVisible

Properties inherited from class javafx.scene.layout.Region

height, maxHeight, maxWidth, minHeight, minWidth, padding, prefHeight, prefWidth, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Nested Class Summary

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

Axis.TickMark<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected DoubleProperty	currentLowerBound The current value for the lowerBound of this axis, ie min value.

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
ValueAxis() Create a auto-ranging ValueAxis
ValueAxis(double lowerBound, double upperBound) Create a non-auto-ranging ValueAxis with the given upper & lower bound

Method Summary

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() Calculate a list of the data values for every minor tick mark
protected double	calculateNewScale(double length, double lowerBound, double upperBound) Calculate a new scale for this axis.
double	getDisplayPosition(T value) Get 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.
StringConverter<T>	getTickLabelFormatter() Gets the value of the property tickLabelFormatter.
double	getUpperBound() Gets the value of the property upperBound.
T	getValueForDisplay(double displayPosition) Get the data value for the given display position on this axis.
double	getZeroPosition() Get the display position of the zero line along this axis.
void	invalidateRange(java.util.List<T> data) Called when data has changed and the range may not be valid any more.
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, ie min 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
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(StringConverter<T> value) Sets the value of the property tickLabelFormatter.
void	setUpperBound(double value) Sets the value of the property upperBound.
ObjectProperty<StringConverter<T>>	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.
DoubleProperty	upperBoundProperty() The value for the upper bound of this axis, ie max value.

Methods inherited from class javafx.scene.chart.Axis

animatedProperty, autoRangingProperty, calculateTickValues, computePrefHeight, computePrefWidth, getAnimated, getLabel, getRange, getSide, getTickLabelFill, getTickLabelFont, getTickLabelGap, getTickLabelRotation, getTickLength, getTickMarkLabel, getTickMarks, invalidateRange, isAutoRanging, isRangeValid, isTickLabelsVisible, isTickMarkVisible, labelProperty, measureTickMarkLabelSize, measureTickMarkSize, measureTickMarkSize, requestAxisLayout, requestLayout, setAnimated, setAutoRanging, setLabel, setRange, setSide, setTickLabelFill, setTickLabelFont, setTickLabelGap, setTickLabelRotation, setTickLabelsVisible, setTickLength, setTickMarkVisible, shouldAnimate, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarkVisibleProperty

Methods inherited from class javafx.scene.layout.Region

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPadding, getPrefHeight, getPrefWidth, getWidth, heightProperty, isResizable, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setSnapToPixel, setWidth, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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, ie max 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, ie min value. This is automatically set if auto ranging is on.

See Also:

getLowerBound(), setLowerBound(double)

tickLabelFormatter

public final ObjectProperty<StringConverter<T extends java.lang.Number>> tickLabelFormatterProperty

StringConverter used to format tick mark labels. If null a default will be used

See Also:

getTickLabelFormatter(), setTickLabelFormatter(StringConverter)

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

currentLowerBound

protected final DoubleProperty currentLowerBound

The current value for the lowerBound of this axis, ie min 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.

Constructor Detail

ValueAxis

public ValueAxis()

Create a auto-ranging ValueAxis

ValueAxis

public ValueAxis(double lowerBound,
         double upperBound)

Create a non-auto-ranging ValueAxis with the given upper & lower bound

Parameters:

lowerBound - The lower bound for this axis, ie min plottable value

upperBound - The upper bound for this axis, ie max plottable value

Method Detail

isMinorTickVisible

public final boolean isMinorTickVisible()

Gets the value of the property minorTickVisible.

Property description:

true if minor tick marks should be displayed

setMinorTickVisible

public final void setMinorTickVisible(boolean value)

Sets the value of the property minorTickVisible.

Property description:

true if minor tick marks should be displayed

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.

Property description:

The scale factor from data units to visual units

setScale

protected final void setScale(double scale)

Sets the value of the property scale.

Property description:

The scale factor from data units to visual units

scaleProperty

public final ReadOnlyDoubleProperty scaleProperty()

The scale factor from data units to visual units

See Also:

getScale(), setScale(double)

getUpperBound

public final double getUpperBound()

Gets the value of the property upperBound.

Property description:

The value for the upper bound of this axis, ie max value. This is automatically set if auto ranging is on.

setUpperBound

public final void setUpperBound(double value)

Sets the value of the property upperBound.

Property description:

The value for the upper bound of this axis, ie max value. This is automatically set if auto ranging is on.

upperBoundProperty

public final DoubleProperty upperBoundProperty()

The value for the upper bound of this axis, ie max 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.

Property description:

The value for the lower bound of this axis, ie min value. This is automatically set if auto ranging is on.

setLowerBound

public final void setLowerBound(double value)

Sets the value of the property lowerBound.

Property description:

The value for the lower bound of this axis, ie min value. This is automatically set if auto ranging is on.

lowerBoundProperty

public final DoubleProperty lowerBoundProperty()

The value for the lower bound of this axis, ie min value. This is automatically set if auto ranging is on.

See Also:

getLowerBound(), setLowerBound(double)

getTickLabelFormatter

public final StringConverter<T> getTickLabelFormatter()

Gets the value of the property tickLabelFormatter.

Property description:

StringConverter used to format tick mark labels. If null a default will be used

setTickLabelFormatter

public final void setTickLabelFormatter(StringConverter<T> value)

Sets the value of the property tickLabelFormatter.

Property description:

StringConverter used to format tick mark labels. If null a default will be used

tickLabelFormatterProperty

public final ObjectProperty<StringConverter<T>> tickLabelFormatterProperty()

StringConverter used to format tick mark labels. If null a default will be used

See Also:

getTickLabelFormatter(), setTickLabelFormatter(StringConverter)

getMinorTickLength

public final double getMinorTickLength()

Gets the value of the property minorTickLength.

Property description:

The length of minor tick mark lines. Set to 0 to not display minor tick marks.

setMinorTickLength

public final void setMinorTickLength(double value)

Sets the value of the property minorTickLength.

Property description:

The length of minor tick mark lines. Set to 0 to not display minor tick marks.

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.

Property description:

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.

setMinorTickCount

public final void setMinorTickCount(int value)

Sets the value of the property minorTickCount.

Property description:

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.

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 effect the state of the axis, changing any properties 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)

Calculate a new scale for this axis. This should not effect any state(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 effect the state of the axis, changing any properties 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()

Calculate 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>

invalidateRange

public void invalidateRange(java.util.List<T> data)

Called when data has changed and the range may not be valid any more. 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)

Get the display position along this axis for a given value

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 or Double.NaN if zero is not in current range;

getValueForDisplay

public T getValueForDisplay(double displayPosition)

Get 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()

Get 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