de.gsi.chart.axes.spi

Class NumericAxis

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

de.gsi.chart.axes.spi.AbstractAxisParameter

de.gsi.chart.axes.spi.AbstractAxis

de.gsi.chart.axes.spi.NumericAxis

All Implemented Interfaces:

Axis, AxisDescription, EventSource, Styleable, EventTarget

public final class NumericAxis
extends AbstractAxis

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.

Compared to the NumberAxis, this one has a few additional features:

• Re-calculates tick unit also when the auto-ranging is off
• Supports configuration of auto-range padding
• Supports configuration of auto-range rounding
• Supports custom tick unit suppliers

Property Summary

Type	Property and Description
DoubleProperty	autoRangePadding Fraction of the range to be applied as padding on both sides of the axis range.
BooleanProperty	forceZeroInRange When true zero is always included in the visible range.
DoubleProperty	tickUnit The value between each major tick mark in data units.
ObjectProperty<TickUnitSupplier>	tickUnitSupplier Strategy to compute major tick unit when auto-range is on or when axis bounds change.

Properties inherited from class de.gsi.chart.axes.spi.AbstractAxis

axisLabelFormatterProperty

Properties inherited from class de.gsi.chart.axes.spi.AbstractAxisParameter

animatedProperty, animationDurationProperty, autoGrowRangingProperty, autoRangeRoundingProperty, autoRangingProperty, autoUnitScalingProperty, axisLabelGapProperty, axisLabelTextAlignmentProperty, axisPaddingProperty, centerAxisPositionProperty, invertAxisProperty, maxProperty, minorTickCountProperty, minorTickLengthProperty, minorTickVisibleProperty, minProperty, nameProperty, overlapPolicyProperty, scaleProperty, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelFormatterProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarkVisibleProperty, timeAxisProperty, unitProperty, unitScalingProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Properties inherited from interface de.gsi.chart.axes.Axis

autoGrowRangingProperty, autoRangingProperty, autoUnitScalingProperty, invertAxisProperty, maxProperty, minProperty, nameProperty, sideProperty, timeAxisProperty, unitProperty, unitScalingProperty

Field Summary

Fields inherited from class de.gsi.chart.axes.spi.AbstractAxis

animator, BURST_LIMIT_CSS_MS, cachedOffset, currentLowerBound, labelOverlap, lock, maxLabelHeight, maxLabelWidth, RANGE_ANIMATION_DURATION_MS, tickMarkDoubleCache, tickMarkSizeCache, tickMarkStringCache

Fields inherited from class de.gsi.chart.axes.spi.AbstractAxisParameter

autoRange, axisLabel, DEFAULT_MINOR_TICK_COUNT, isInvertedAxis, isTimeAxis, majorTickMarks, majorTickStyle, maxProp, measureInvalid, minorTickMarks, minorTickStyle, minProp, oldAxisLength, rangeValid, scaleBinding, tickLabelRotation, tickLabelsVisibleInvalid, userRange

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
NumericAxis() Creates an auto-ranging Axis.
NumericAxis(double lowerBound, double upperBound, double tickUnit) Creates a non-auto-ranging Axis with the given upper bound, lower bound and tick unit.
NumericAxis(String axisLabel, double lowerBound, double upperBound, double tickUnit) Create a non-auto-ranging Axis with the given upper bound, lower bound and tick unit.

Method Summary

Modifier and Type	Method and Description
protected AxisRange	autoRange(double minValue, double maxValue, double length, double labelSize) We suppress requestLayout() calls here by doing nothing as we don't want changes to our children to cause layout.
DoubleProperty	autoRangePaddingProperty() Fraction of the range to be applied as padding on both sides of the axis range.
protected List<Double>	calculateMajorTickValues(double axisLength, AxisRange range) Calculate a list of all the data values for each tick mark in range
protected List<Double>	calculateMinorTickValues() Calculate a list of the data values for every minor tick mark
double	computePreferredTickUnit(double axisLength) Computes the preferred tick unit based on the upper/lower bounds and the length of the axis in screen coordinates.
protected AxisRange	computeRange(double min, double max, double axisLength, double labelSize) Computes range of this axis, similarly to AbstractAxis.autoRange(double, double, double, double).
BooleanProperty	forceZeroInRangeProperty() When true zero is always included in the visible range.
double	getAutoRangePadding() Returns the value of the autoRangePaddingProperty().
protected AxisRange	getAxisRange()
AxisTransform	getAxisTransform()
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
List<CssMetaData<? extends Styleable,?>>	getCssMetaData()
double	getDisplayPosition(double value) Get the display position along this axis for a given value.
LogAxisType	getLogAxisType()
double	getTickUnit() Returns tick unit value expressed in data units.
TickUnitSupplier	getTickUnitSupplier() Returns the value of the tickUnitSupplierProperty().
double	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.
boolean	isForceZeroInRange() Returns the value of the forceZeroInRangeProperty().
boolean	isLogAxis() This is true when the axis implements a log scale
boolean	isValueOnAxis(double value) Checks if the given value is plottable on this axis
void	setAutoRangePadding(double padding) Sets the value of the autoRangePaddingProperty()
void	setForceZeroInRange(boolean value) Sets the value of the forceZeroInRangeProperty().
protected void	setRange(AxisRange range, boolean animate)
void	setTickUnit(double unit) Sets the value of the tickUnitProperty().
void	setTickUnitSupplier(TickUnitSupplier supplier) Sets the value of the tickUnitSupplierProperty().
DoubleProperty	tickUnitProperty() The value between each major tick mark in data units.
ObjectProperty<TickUnitSupplier>	tickUnitSupplierProperty() Strategy to compute major tick unit when auto-range is on or when axis bounds change.

Methods inherited from class de.gsi.chart.axes.spi.AbstractAxis

autoRange, axisLabelFormatterProperty, calculateNewScale, clearAxisCanvas, computePrefHeight, computePrefWidth, computeTickMarks, drawAxis, drawAxisLabel, drawAxisLabel, drawAxisLine, drawAxisPost, drawAxisPre, drawTickLabels, drawTickMarkLabel, drawTickMarks, fireInvalidated, forceRedraw, getAxisLabelFormatter, getCanvas, getGraphicsContext, getMaxTickLabelHeight, getMaxTickLabelWidth, getNewTickMark, getTickMarkLabel, invalidateRange, invalidateRange, isLabelOverlapping, isRangeValid, layoutChildren, measureTickMarkLength, recomputeTickMarks, recomputeTickMarks, requestAxisLayout, setAxisLabelFormatter, setMax, setMin, shouldAnimate, snap, tickMarksUpdated, updateCachedVariables, updateCSS

Methods inherited from class de.gsi.chart.axes.spi.AbstractAxisParameter

add, add, animatedProperty, animationDurationProperty, autoGrowRangingProperty, autoNotification, autoRangeRoundingProperty, autoRangingProperty, autoUnitScalingProperty, axisLabelGapProperty, axisLabelTextAlignmentProperty, axisPaddingProperty, centerAxisPositionProperty, clear, contains, decadeRange, getaAxisLabelTextAlignment, getAnimationDuration, getAutoRange, getAxisLabel, getAxisLabelGap, getAxisPadding, getCenterAxisPosition, getLength, getMajorTickStyle, getMax, getMin, getMinorTickCount, getMinorTickLength, getMinorTickMarks, getMinorTickStyle, getName, getOverlapPolicy, getRange, getScale, getSide, getTickLabelFill, getTickLabelFont, getTickLabelFormatter, getTickLabelGap, getTickLabelRotation, getTickLength, getTickMarks, getUnit, getUnitScaling, getUserRange, invertAxis, invertAxisProperty, invokeListener, isAnimated, isAutoGrowRanging, isAutoRangeRounding, isAutoRanging, isAutoUnitScaling, isDefined, isInvertedAxis, isMinorTickVisible, isTickLabelsVisible, isTickMarkVisible, isTimeAxis, maxProperty, minorTickCountProperty, minorTickLengthProperty, minorTickVisibleProperty, minProperty, nameProperty, overlapPolicyProperty, scaleProperty, set, set, set, setAnimated, setAnimationDuration, setAutoGrowRanging, setAutoRangeRounding, setAutoRanging, setAutoUnitScaling, setAxisCentrePosition, setAxisLabelAlignment, setAxisLabelGap, setAxisPadding, setMinorTickCount, setMinorTickLength, setMinorTickVisible, setName, setOverlapPolicy, setScale, setSide, setTickLabelFill, setTickLabelFont, setTickLabelFormatter, setTickLabelGap, setTickLabelRotation, setTickLabelsVisible, setTickLength, setTickMarkVisible, setTimeAxis, setUnit, setUnitScaling, setUnitScaling, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelFormatterProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarkVisibleProperty, timeAxisProperty, unitProperty, unitScalingProperty, updateAxisLabelAndUnit, updateEventListener, updateScaleAndUnitPrefix

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, 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, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, 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, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.gsi.chart.axes.Axis

autoGrowRangingProperty, autoRangingProperty, autoUnitScalingProperty, getAutoRange, getHeight, getLength, getMinorTickCount, getMinorTickMarks, getRange, getSide, getTickLabelFill, getTickLabelFont, getTickLabelFormatter, getTickLabelGap, getTickMarks, getUnitScaling, getUserRange, getWidth, invertAxis, invertAxisProperty, invokeListener, isAutoGrowRanging, isAutoRanging, isAutoUnitScaling, isInvertedAxis, isTimeAxis, maxProperty, minProperty, nameProperty, setAnimated, setAutoGrowRanging, setAutoRanging, setAutoUnitScaling, setName, setSide, setTimeAxis, setUnit, setUnitScaling, setUnitScaling, sideProperty, timeAxisProperty, unitProperty, unitScalingProperty

Methods inherited from interface de.gsi.dataset.AxisDescription

add, add, add, clear, contains, getMax, getMin, getName, getUnit, isDefined, set, set, set, set

Methods inherited from interface de.gsi.dataset.event.EventSource

addListener, autoNotification, invokeListener, invokeListener, isAutoNotification, removeListener, updateEventListener

Property Detail

autoRangePadding

public DoubleProperty autoRangePaddingProperty

Fraction of the range to be applied as padding on both sides of the axis range. E.g. if set to 0.1 (10%) on axis with data range [10, 20], the new automatically calculated range will be [9, 21].

Overrides:

autoRangePaddingProperty in class AbstractAxisParameter

See Also:

getAutoRangePadding(), setAutoRangePadding(double)

forceZeroInRange

public 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 DoubleProperty tickUnitProperty

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

Specified by:

tickUnitProperty in interface Axis

Overrides:

tickUnitProperty in class AbstractAxisParameter

See Also:

getTickUnit(), setTickUnit(double)

tickUnitSupplier

public ObjectProperty<TickUnitSupplier> tickUnitSupplierProperty

Strategy to compute major tick unit when auto-range is on or when axis bounds change. By default initialized to DefaultTickUnitSupplier.

See TickUnitSupplier for more information about the expected behavior of the strategy.

See Also:

getTickUnitSupplier(), setTickUnitSupplier(TickUnitSupplier)

Constructor Detail

NumericAxis

public NumericAxis()

Creates an auto-ranging Axis.

NumericAxis

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

Creates a non-auto-ranging Axis with the given upper bound, lower bound and tick unit.

Parameters:

lowerBound - the lower bound of the axis

upperBound - the upper bound of the axis

tickUnit - the tick unit, i.e. space between tick marks

NumericAxis

public NumericAxis(String axisLabel,
                   double lowerBound,
                   double upperBound,
                   double tickUnit)

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

Parameters:

axisLabel - the axis label

lowerBound - the lower bound of the axis

upperBound - the upper bound of the axis

tickUnit - the tick unit, i.e. space between tick marks

Method Detail

autoRange

protected AxisRange autoRange(double minValue,
                              double maxValue,
                              double length,
                              double labelSize)

Description copied from class: AbstractAxis

We suppress requestLayout() calls here by doing nothing as we don't want changes to our children to cause layout. If you really need to request layout then call requestAxisLayout(). TODO: re-enable

Overrides:

autoRange in class AbstractAxis

autoRangePaddingProperty

public DoubleProperty autoRangePaddingProperty()

Fraction of the range to be applied as padding on both sides of the axis range. E.g. if set to 0.1 (10%) on axis with data range [10, 20], the new automatically calculated range will be [9, 21].

Overrides:

autoRangePaddingProperty in class AbstractAxisParameter

See Also:

getAutoRangePadding(), setAutoRangePadding(double)

calculateMajorTickValues

protected List<Double> calculateMajorTickValues(double axisLength,
                                                AxisRange range)

Description copied from class: AbstractAxis

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

Specified by:

calculateMajorTickValues in class AbstractAxis

Parameters:

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

calculateMinorTickValues

protected List<Double> calculateMinorTickValues()

Description copied from class: AbstractAxis

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

Specified by:

calculateMinorTickValues in class AbstractAxis

Returns:

List of data values where to draw minor tick marks

computePreferredTickUnit

public double computePreferredTickUnit(double axisLength)

Computes the preferred tick unit based on the upper/lower bounds and the length of the axis in screen coordinates.

Specified by:

computePreferredTickUnit in class AbstractAxis

Parameters:

axisLength - the length in screen coordinates

Returns:

the tick unit

computeRange

protected AxisRange computeRange(double min,
                                 double max,
                                 double axisLength,
                                 double labelSize)

Description copied from class: AbstractAxis

Computes range of this axis, similarly to AbstractAxis.autoRange(double, double, double, double). The major difference is that this method is called when auto-range is off.

Specified by:

computeRange in class AbstractAxis

Parameters:

min - The min data value that needs to be plotted on this axis

max - The max data value that needs to be plotted on this axis

axisLength - The length of the axis in display coordinates

labelSize - The approximate average size a label takes along the axis

Returns:

The calculated range

See Also:

AbstractAxis.autoRange(double, double, double, double)

forceZeroInRangeProperty

public 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)

getAutoRangePadding

public double getAutoRangePadding()

Returns the value of the autoRangePaddingProperty().

Overrides:

getAutoRangePadding in class AbstractAxisParameter

Returns:

the auto range padding

getAxisRange

protected AxisRange getAxisRange()

Overrides:

getAxisRange in class AbstractAxis

Returns:

axsis range that is supposed to be shown

getAxisTransform

public AxisTransform getAxisTransform()

getCssMetaData

public List<CssMetaData<? extends Styleable,?>> getCssMetaData()

Description copied from class: AbstractAxisParameter

Specified by:

getCssMetaData in interface Styleable

Overrides:

getCssMetaData in class AbstractAxisParameter

getDisplayPosition

public double getDisplayPosition(double value)

Get 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. -- cached double optimised version (shaves of 50% on delays)

Specified by:

getDisplayPosition in interface Axis

Overrides:

getDisplayPosition in class AbstractAxis

Parameters:

value - The data value to work out display position for

Returns:

display position

getLogAxisType

public LogAxisType getLogAxisType()

Returns:

given linear and/or logarithmic (+ sub-type, e.g. log10, dB20, ...) axis types

getTickUnit

public double getTickUnit()

Returns tick unit value expressed in data units.

Specified by:

getTickUnit in interface Axis

Overrides:

getTickUnit in class AbstractAxisParameter

Returns:

major tick unit value

getTickUnitSupplier

public TickUnitSupplier getTickUnitSupplier()

Returns the value of the tickUnitSupplierProperty().

Returns:

the TickUnitSupplier

getValueForDisplay

public double 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. -- cached double optimised version (shaves of 50% on delays)

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 interface Axis

Overrides:

getZeroPosition in class AbstractAxis

Returns:

display position or Double.NaN if zero is not in current range;

isForceZeroInRange

public boolean isForceZeroInRange()

Returns the value of the forceZeroInRangeProperty().

Returns:

value of the forceZeroInRange property

isLogAxis

public boolean isLogAxis()

Description copied from interface: Axis

This is true when the axis implements a log scale

Returns:

true if axis is log scale

isValueOnAxis

public boolean isValueOnAxis(double value)

Checks if the given value is plottable on this axis

Specified by:

isValueOnAxis in interface Axis

Overrides:

isValueOnAxis in class AbstractAxis

Parameters:

value - The value to check if its on axis

Returns:

true if the given value is plottable on this axis

setAutoRangePadding

public void setAutoRangePadding(double padding)

Sets the value of the autoRangePaddingProperty()

Overrides:

setAutoRangePadding in class AbstractAxisParameter

Parameters:

padding - padding factor

setForceZeroInRange

public void setForceZeroInRange(boolean value)

Sets the value of the forceZeroInRangeProperty().

Parameters:

value - if true, zero is always included in the visible range

setRange

protected void setRange(AxisRange range,
                        boolean animate)

Overrides:

setRange in class AbstractAxis

setTickUnit

public void setTickUnit(double unit)

Sets the value of the tickUnitProperty().

Specified by:

setTickUnit in interface Axis

Overrides:

setTickUnit in class AbstractAxisParameter

Parameters:

unit - major tick unit

setTickUnitSupplier

public void setTickUnitSupplier(TickUnitSupplier supplier)

Sets the value of the tickUnitSupplierProperty().

Parameters:

supplier - the tick unit supplier. If null, the default one will be used

tickUnitProperty

public DoubleProperty tickUnitProperty()

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

Specified by:

tickUnitProperty in interface Axis

Overrides:

tickUnitProperty in class AbstractAxisParameter

See Also:

getTickUnit(), setTickUnit(double)

tickUnitSupplierProperty

public ObjectProperty<TickUnitSupplier> tickUnitSupplierProperty()

Strategy to compute major tick unit when auto-range is on or when axis bounds change. By default initialized to DefaultTickUnitSupplier.

See TickUnitSupplier for more information about the expected behavior of the strategy.

See Also:

getTickUnitSupplier(), setTickUnitSupplier(TickUnitSupplier)

getClassCssMetaData

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()