javafx.scene.chart

Class NumberAxis

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.chart.Axis<T>

javafx.scene.chart.ValueAxis<java.lang.Number>

javafx.scene.chart.NumberAxis

All Implemented Interfaces:

EventTarget

public final class NumberAxis
extends ValueAxis<java.lang.Number>

A axis class that plots a range of numbers with major tick marks every "tickUnit". You can use any Number type with this axis, Long, Double, BigDecimal etc.

Property Summary

Properties

Type	Property and Description
BooleanProperty	forceZeroInRange When true zero is always included in the visible range.
DoubleProperty	tickUnit The value between each major tick mark in data units.

Properties inherited from class javafx.scene.chart.ValueAxis

lowerBound, minorTickCount, minorTickLength, minorTickVisible, scale, tickLabelFormatter, upperBound

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

Modifier and Type	Class and Description
static class	NumberAxis.DefaultFormatter Default number formatter for NumberAxis, this stays in sync with auto-ranging and formats values appropriately.

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

Axis.TickMark<T>

Field Summary

Fields inherited from class javafx.scene.chart.ValueAxis

currentLowerBound

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
NumberAxis() Create a auto-ranging NumberAxis
NumberAxis(double lowerBound, double upperBound, double tickUnit) Create a non-auto-ranging NumberAxis with the given upper bound, lower bound and tick unit
NumberAxis(java.lang.String axisLabel, double lowerBound, double upperBound, double tickUnit) Create a non-auto-ranging NumberAxis with the given upper bound, lower bound and tick unit

Method Summary

Methods

Modifier and Type	Method and Description
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 java.util.List<java.lang.Number>	calculateMinorTickMarks() Calculate a list of the data values for every minor tick mark
protected java.util.List<java.lang.Number>	calculateTickValues(double length, java.lang.Object range) Calculate a list of all the data values for each tick mark in range
BooleanProperty	forceZeroInRangeProperty() When true zero is always included in the visible range.
protected java.lang.Object	getRange() Called to get the current axis range.
protected java.lang.String	getTickMarkLabel(java.lang.Number value) Get the string label name for a tick mark with the given value
double	getTickUnit() Gets the value of the property tickUnit.
boolean	isForceZeroInRange() Gets the value of the property forceZeroInRange.
protected Dimension2D	measureTickMarkSize(java.lang.Number value, java.lang.Object range) Measure the size of the label for given tick mark value.
void	setForceZeroInRange(boolean value) Sets the value of the property forceZeroInRange.
protected void	setRange(java.lang.Object range, boolean animate) Called to set the current axis range to the given range.
void	setTickUnit(double value) Sets the value of the property tickUnit.
DoubleProperty	tickUnitProperty() The value between each major tick mark in data units.

Methods inherited from class javafx.scene.chart.ValueAxis

autoRange, calculateNewScale, getDisplayPosition, getLowerBound, getMinorTickCount, getMinorTickLength, getScale, getTickLabelFormatter, getUpperBound, getValueForDisplay, getZeroPosition, invalidateRange, isMinorTickVisible, isValueOnAxis, layoutChildren, lowerBoundProperty, minorTickCountProperty, minorTickLengthProperty, minorTickVisibleProperty, scaleProperty, setLowerBound, setMinorTickCount, setMinorTickLength, setMinorTickVisible, setScale, setTickLabelFormatter, setUpperBound, tickLabelFormatterProperty, tickMarksUpdated, toNumericValue, toRealValue, upperBoundProperty

Methods inherited from class javafx.scene.chart.Axis

animatedProperty, autoRangingProperty, computePrefHeight, computePrefWidth, getAnimated, getLabel, getSide, getTickLabelFill, getTickLabelFont, getTickLabelGap, getTickLabelRotation, getTickLength, getTickMarks, invalidateRange, isAutoRanging, isRangeValid, isTickLabelsVisible, isTickMarkVisible, labelProperty, measureTickMarkLabelSize, measureTickMarkSize, requestAxisLayout, requestLayout, setAnimated, setAutoRanging, setLabel, 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

forceZeroInRange

public final BooleanProperty forceZeroInRangeProperty

When true zero is always included in the visible range. This only has effect if auto-ranging is on.

See Also:

isForceZeroInRange(), setForceZeroInRange(boolean)

tickUnit

public final DoubleProperty tickUnitProperty

The value between each major tick mark in data units. This is automatically set if we are auto-ranging.

See Also:

getTickUnit(), setTickUnit(double)

Constructor Detail

NumberAxis

public NumberAxis()

Create a auto-ranging NumberAxis

NumberAxis

public NumberAxis(double lowerBound,
          double upperBound,
          double tickUnit)

Create a non-auto-ranging NumberAxis with the given upper bound, lower bound and tick unit

Parameters:

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

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

tickUnit - The tick unit, ie space between tickmarks

NumberAxis

public NumberAxis(java.lang.String axisLabel,
          double lowerBound,
          double upperBound,
          double tickUnit)

Create a non-auto-ranging NumberAxis with the given upper bound, lower bound and tick unit

Parameters:

axisLabel - The name to display for this axis

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

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

tickUnit - The tick unit, ie space between tickmarks

Method Detail

isForceZeroInRange

public final boolean isForceZeroInRange()

Gets the value of the property forceZeroInRange.

Property description:

When true zero is always included in the visible range. This only has effect if auto-ranging is on.

setForceZeroInRange

public final void setForceZeroInRange(boolean value)

Sets the value of the property forceZeroInRange.

Property description:

When true zero is always included in the visible range. This only has effect if auto-ranging is on.

forceZeroInRangeProperty

public final BooleanProperty forceZeroInRangeProperty()

When true zero is always included in the visible range. This only has effect if auto-ranging is on.

See Also:

isForceZeroInRange(), setForceZeroInRange(boolean)

getTickUnit

public final double getTickUnit()

Gets the value of the property tickUnit.

Property description:

The value between each major tick mark in data units. This is automatically set if we are auto-ranging.

setTickUnit

public final void setTickUnit(double value)

Sets the value of the property tickUnit.

Property description:

The value between each major tick mark in data units. This is automatically set if we are auto-ranging.

tickUnitProperty

public final DoubleProperty tickUnitProperty()

The value between each major tick mark in data units. This is automatically set if we are auto-ranging.

See Also:

getTickUnit(), setTickUnit(double)

getTickMarkLabel

protected java.lang.String getTickMarkLabel(java.lang.Number value)

Get the string label name for a tick mark with the given value

Specified by:

getTickMarkLabel in class Axis<java.lang.Number>

Parameters:

value - The value to format into a tick label string

Returns:

A formatted string for the given value

getRange

protected java.lang.Object getRange()

Called to get the current axis range.

Specified by:

getRange in class Axis<java.lang.Number>

Returns:

A range object that can be passed to setRange() and calculateTickValues()

setRange

protected void setRange(java.lang.Object range,
            boolean animate)

Called to set the current axis range to the given range. If isAnimating() is true then this method should animate the range to the new range.

Specified by:

setRange in class Axis<java.lang.Number>

Parameters:

range - A range object returned from autoRange()

animate - If true animate the change in range

calculateTickValues

protected java.util.List<java.lang.Number> calculateTickValues(double length,
                                                   java.lang.Object range)

Calculate a list of all the data values for each tick mark in range

Specified by:

calculateTickValues in class Axis<java.lang.Number>

Parameters:

length - The length of the axis in display units

range - A range object returned from autoRange()

Returns:

A list of tick marks that fit along the axis if it was the given length

calculateMinorTickMarks

protected java.util.List<java.lang.Number> calculateMinorTickMarks()

Calculate a list of the data values for every minor tick mark

Specified by:

calculateMinorTickMarks in class ValueAxis<java.lang.Number>

Returns:

List of data values where to draw minor tick marks

measureTickMarkSize

protected Dimension2D measureTickMarkSize(java.lang.Number value,
                              java.lang.Object range)

Measure the size of the label for given tick mark value. This uses the font that is set for the tick marks

Overrides:

measureTickMarkSize in class Axis<java.lang.Number>

Parameters:

value - tick mark value

range - range to use during calculations

Returns:

size of tick mark label for given value

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

Overrides:

autoRange in class ValueAxis<java.lang.Number>

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