de.gsi.chart.axes.spi

Class DefaultNumericAxis

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.DefaultNumericAxis

All Implemented Interfaces:

Axis, AxisDescription, EventSource, Styleable, EventTarget

Direct Known Subclasses:

CategoryAxis, ColorGradientAxis

public class DefaultNumericAxis
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 tickUnitSupplierProperty tick unit suppliers

Author:

rstein

Property Summary

Type	Property and Description
BooleanProperty	forceZeroInRange When true zero is always included in the visible range.
DoubleProperty	logarithmBase Base of the logarithm used by the axis, must be grater than 1.
BooleanProperty	logAxis When true axis is being a log-axis (default = false)

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

axisLabelFormatterProperty

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

animatedProperty, animationDurationProperty, autoGrowRangingProperty, autoRangePaddingProperty, 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, tickUnitProperty, 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, tickUnitProperty, timeAxisProperty, unitProperty, unitScalingProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultNumericAxis.Cache

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_LOG_MIN_VALUE
protected boolean	isLogAxis
protected boolean	isUpdating

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, tickUnit, 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
DefaultNumericAxis() Creates an auto-ranging Axis.
DefaultNumericAxis(double lowerBound, double upperBound, double tickUnit) Creates a non-auto-ranging Axis with the given upper bound, lower bound and tick unit.
DefaultNumericAxis(String axisLabel) Creates an auto-ranging Axis.
DefaultNumericAxis(String axisLabel, double lowerBound, double upperBound, double tickUnit) Create a non-auto-ranging Axis with the given upper bound, lower bound and tick unit.
DefaultNumericAxis(String axisLabel, String unit) Creates an auto-ranging Axis.

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.
protected List<Double>	calculateMajorTickValues(double axisLength, AxisRange axisRange) 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
protected static double	clampBoundToZero(double paddedBound, double bound) If padding pushed the bound above or below zero - stick it to zero.
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).
protected double	computeTickUnit(double rawTickUnit)
BooleanProperty	forceZeroInRangeProperty() When true zero is always included in the visible range.
AxisTransform	getAxisTransform() Gets the transformation (linear, logarithmic, etc) applied to the values of this axis.
double	getDisplayPosition(double value) Get the display position along this axis for a given value.
protected static double	getEffectiveRange(double min, double max)
double	getLogarithmBase() Returns the value of the logarithmBaseProperty().
LogAxisType	getLogAxisType()
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() Returns the value of the logAxisProperty().
boolean	isValueOnAxis(double value) Checks if the given value is plottable on this axis
DoubleProperty	logarithmBaseProperty() Base of the logarithm used by the axis, must be grater than 1.
BooleanProperty	logAxisProperty() When true axis is being a log-axis (default = false)
void	requestAxisLayout() Request that the axis is laid out in the next layout pass.
void	setForceZeroInRange(boolean value) Sets the value of the forceZeroInRangeProperty().
void	setLogarithmBase(double value) Sets value of the logarithmBaseProperty().
void	setLogAxis(boolean value) Sets the value of the logAxisProperty().
protected void	setRange(AxisRange range, boolean animate)
protected void	updateCachedVariables() to be overwritten by derived class that want to cache variables for efficiency reasons

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, getAxisRange, getCanvas, getGraphicsContext, getMaxTickLabelHeight, getMaxTickLabelWidth, getNewTickMark, getTickMarkLabel, invalidateRange, invalidateRange, isLabelOverlapping, isRangeValid, layoutChildren, measureTickMarkLength, recomputeTickMarks, recomputeTickMarks, setAxisLabelFormatter, setMax, setMin, shouldAnimate, snap, tickMarksUpdated, updateCSS

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

add, add, animatedProperty, animationDurationProperty, autoGrowRangingProperty, autoNotification, autoRangePaddingProperty, autoRangeRoundingProperty, autoRangingProperty, autoUnitScalingProperty, axisLabelGapProperty, axisLabelTextAlignmentProperty, axisPaddingProperty, centerAxisPositionProperty, clear, contains, decadeRange, getaAxisLabelTextAlignment, getAnimationDuration, getAutoRange, getAutoRangePadding, getAxisLabel, getAxisLabelGap, getAxisPadding, getCenterAxisPosition, getClassCssMetaData, getCssMetaData, getLength, getMajorTickStyle, getMax, getMin, getMinorTickCount, getMinorTickLength, getMinorTickMarks, getMinorTickStyle, getName, getOverlapPolicy, getRange, getScale, getSide, getTickLabelFill, getTickLabelFont, getTickLabelFormatter, getTickLabelGap, getTickLabelRotation, getTickLength, getTickMarks, getTickUnit, 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, setAutoRangePadding, setAutoRangeRounding, setAutoRanging, setAutoUnitScaling, setAxisCentrePosition, setAxisLabelAlignment, setAxisLabelGap, setAxisPadding, setMinorTickCount, setMinorTickLength, setMinorTickVisible, setName, setOverlapPolicy, setScale, setSide, setTickLabelFill, setTickLabelFont, setTickLabelFormatter, setTickLabelGap, setTickLabelRotation, setTickLabelsVisible, setTickLength, setTickMarkVisible, setTickUnit, setTimeAxis, setUnit, setUnitScaling, setUnitScaling, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelFormatterProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarkVisibleProperty, tickUnitProperty, 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, getTickUnit, getUnitScaling, getUserRange, getWidth, invertAxis, invertAxisProperty, invokeListener, isAutoGrowRanging, isAutoRanging, isAutoUnitScaling, isInvertedAxis, isTimeAxis, maxProperty, minProperty, nameProperty, setAnimated, setAutoGrowRanging, setAutoRanging, setAutoUnitScaling, setName, setSide, setTickUnit, setTimeAxis, setUnit, setUnitScaling, setUnitScaling, sideProperty, tickUnitProperty, 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

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)

logarithmBase

public DoubleProperty logarithmBaseProperty

Base of the logarithm used by the axis, must be grater than 1.

Default value: 10

See Also:

getLogarithmBase(), setLogarithmBase(double)

logAxis

public BooleanProperty logAxisProperty

When true axis is being a log-axis (default = false)

See Also:

isLogAxis(), setLogAxis(boolean)

Field Detail

DEFAULT_LOG_MIN_VALUE

public static final double DEFAULT_LOG_MIN_VALUE

See Also:

Constant Field Values

isUpdating

protected boolean isUpdating

isLogAxis

protected boolean isLogAxis

Constructor Detail

DefaultNumericAxis

public DefaultNumericAxis()

Creates an auto-ranging Axis.

DefaultNumericAxis

public DefaultNumericAxis(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

DefaultNumericAxis

public DefaultNumericAxis(String axisLabel)

Creates an auto-ranging Axis.

Parameters:

axisLabel - the axis label

DefaultNumericAxis

public DefaultNumericAxis(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

DefaultNumericAxis

public DefaultNumericAxis(String axisLabel,
                          String unit)

Creates an auto-ranging Axis.

Parameters:

axisLabel - the axis label

unit - the unit of the axis axis label

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

calculateMajorTickValues

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

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

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

computeTickUnit

protected double computeTickUnit(double rawTickUnit)

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)

getAxisTransform

public AxisTransform getAxisTransform()

Gets the transformation (linear, logarithmic, etc) applied to the values of this axis.

Returns:

the axis transformation

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

getLogarithmBase

public double getLogarithmBase()

Returns the value of the logarithmBaseProperty().

Returns:

base of the logarithm

getLogAxisType

public LogAxisType getLogAxisType()

Returns:

the log axis Type @see LogAxisType

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

Returns the value of the logAxisProperty().

Returns:

value of the logAxis property

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

logarithmBaseProperty

public DoubleProperty logarithmBaseProperty()

Base of the logarithm used by the axis, must be grater than 1.

Default value: 10

See Also:

getLogarithmBase(), setLogarithmBase(double)

logAxisProperty

public BooleanProperty logAxisProperty()

When true axis is being a log-axis (default = false)

See Also:

isLogAxis(), setLogAxis(boolean)

requestAxisLayout

public void requestAxisLayout()

Description copied from class: AbstractAxis

Request that the axis is laid out in the next layout pass. This replaces requestLayout() as it has been overridden to do nothing so that changes to children's bounds etc do not cause a layout. This was done as a optimisation as the Axis knows the exact minimal set of changes that really need layout to be updated. So we only want to request layout then, not on any child change.

Specified by:

requestAxisLayout in interface Axis

Overrides:

requestAxisLayout in class AbstractAxis

setForceZeroInRange

public void setForceZeroInRange(boolean value)

Sets the value of the forceZeroInRangeProperty().

Parameters:

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

setLogarithmBase

public void setLogarithmBase(double value)

Sets value of the logarithmBaseProperty().

Parameters:

value - base of the logarithm, value > 1

setLogAxis

public void setLogAxis(boolean value)

Sets the value of the logAxisProperty().

Parameters:

value - if true, log axis is drawn

setRange

protected void setRange(AxisRange range,
                        boolean animate)

Overrides:

setRange in class AbstractAxis

updateCachedVariables

protected void updateCachedVariables()

Description copied from class: AbstractAxis

to be overwritten by derived class that want to cache variables for efficiency reasons

Overrides:

updateCachedVariables in class AbstractAxis

clampBoundToZero

protected static double clampBoundToZero(double paddedBound,
                                         double bound)

If padding pushed the bound above or below zero - stick it to zero.

Parameters:

paddedBound - padded version of bound

bound - computed raw version of bound

Returns:

clamped value

getEffectiveRange

protected static double getEffectiveRange(double min,
                                          double max)