cern.extjfx.chart

Class NumericAxis

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.chart.Axis<T>

javafx.scene.chart.ValueAxis<Number>

cern.extjfx.chart.AbstractNumericAxis

cern.extjfx.chart.NumericAxis

All Implemented Interfaces:

Styleable, EventTarget

public final class NumericAxis
extends AbstractNumericAxis

Linear numeric axis.

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 set to 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 cern.extjfx.chart.AbstractNumericAxis

autoRangeRoundingProperty

Properties inherited from class javafx.scene.chart.ValueAxis

lowerBoundProperty, minorTickCountProperty, minorTickLengthProperty, minorTickVisibleProperty, scaleProperty, tickLabelFormatterProperty, upperBoundProperty

Properties inherited from class javafx.scene.chart.Axis

animatedProperty, autoRangingProperty, labelProperty, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarkVisibleProperty

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

Nested Class Summary

Nested classes/interfaces inherited from class cern.extjfx.chart.AbstractNumericAxis

AbstractNumericAxis.DefaultFormatter, AbstractNumericAxis.Range

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

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Object	autoRange(double minValue, double maxValue, double length, double labelSize)
DoubleProperty	autoRangePaddingProperty() Fraction of the range to be applied as padding on both sides of the axis range.
protected List<Number>	calculateMinorTickMarks()
protected List<Number>	calculateTickValues(double axisLength, Object range)
protected AbstractNumericAxis.Range	computeRange(double min, double max, double axisLength, double labelSize) Computes range of this axis, similarly to ValueAxis.autoRange(double, double, double, double).
BooleanProperty	forceZeroInRangeProperty() When set to true zero is always included in the visible range.
double	getAutoRangePadding() Returns the value of the autoRangePaddingProperty().
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
List<CssMetaData<? extends Styleable,?>>	getCssMetaData()
protected AbstractNumericAxis.Range	getRange()
double	getTickUnit() Returns tick unit value expressed in data units.
TickUnitSupplier	getTickUnitSupplier() Returns the value of the tickUnitSupplierProperty().
boolean	isForceZeroInRange() Returns the value of the forceZeroInRangeProperty().
void	setAutoRangePadding(double padding) Sets the value of the autoRangePaddingProperty()
void	setForceZeroInRange(boolean value) Sets the value of the forceZeroInRangeProperty().
protected void	setRange(Object 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 cern.extjfx.chart.AbstractNumericAxis

autoRangeRoundingProperty, getTickMarkLabel, isAutoRangeRounding, measureTickMarkSize, measureTickMarkSizeWithFormat, setAutoRangeRounding

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

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, getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, 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

Property Detail

forceZeroInRange

public BooleanProperty forceZeroInRangeProperty

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

See Also:

isForceZeroInRange(), setForceZeroInRange(boolean)

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

See Also:

getAutoRangePadding(), setAutoRangePadding(double)

tickUnit

public DoubleProperty tickUnitProperty

The value between each major tick mark in data units.

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

NumericAxis

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

Creates a non-auto-ranging NumericAxis 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 NumericAxis 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

forceZeroInRangeProperty

public BooleanProperty forceZeroInRangeProperty()

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

See Also:

isForceZeroInRange(), setForceZeroInRange(boolean)

isForceZeroInRange

public boolean isForceZeroInRange()

Returns the value of the forceZeroInRangeProperty().

Returns:

value of the forceZeroInRange property

setForceZeroInRange

public void setForceZeroInRange(boolean value)

Sets the value of the forceZeroInRangeProperty().

Parameters:

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

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

See Also:

getAutoRangePadding(), setAutoRangePadding(double)

getAutoRangePadding

public double getAutoRangePadding()

Returns the value of the autoRangePaddingProperty().

Returns:

the auto range padding

setAutoRangePadding

public void setAutoRangePadding(double padding)

Sets the value of the autoRangePaddingProperty()

Parameters:

padding - padding factor

tickUnitProperty

public DoubleProperty tickUnitProperty()

The value between each major tick mark in data units.

See Also:

getTickUnit(), setTickUnit(double)

getTickUnit

public double getTickUnit()

Returns tick unit value expressed in data units.

Returns:

major tick unit value

setTickUnit

public void setTickUnit(double unit)

Sets the value of the tickUnitProperty().

Parameters:

unit - major tick unit

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)

getTickUnitSupplier

public TickUnitSupplier getTickUnitSupplier()

Returns the value of the tickUnitSupplierProperty().

Returns:

the TickUnitSupplier

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

setRange

protected void setRange(Object range,
                        boolean animate)

Overrides:

setRange in class AbstractNumericAxis

calculateTickValues

protected List<Number> calculateTickValues(double axisLength,
                                           Object range)

Specified by:

calculateTickValues in class Axis<Number>

calculateMinorTickMarks

protected List<Number> calculateMinorTickMarks()

Specified by:

calculateMinorTickMarks in class ValueAxis<Number>

getRange

protected AbstractNumericAxis.Range getRange()

Overrides:

getRange in class AbstractNumericAxis

autoRange

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

Overrides:

autoRange in class ValueAxis<Number>

computeRange

protected AbstractNumericAxis.Range computeRange(double min,
                                                 double max,
                                                 double axisLength,
                                                 double labelSize)

Description copied from class: AbstractNumericAxis

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

Specified by:

computeRange in class AbstractNumericAxis

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:

ValueAxis.autoRange(double, double, double, double)

getClassCssMetaData

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

getCssMetaData

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

Specified by:

getCssMetaData in interface Styleable

Overrides:

getCssMetaData in class ValueAxis<Number>