Package de.gsi.chart.axes.spi
Class AbstractAxisParameter
- java.lang.Object
-
- javafx.scene.Node
-
- javafx.scene.Parent
-
- javafx.scene.layout.Region
-
- javafx.scene.layout.Pane
-
- de.gsi.chart.axes.spi.AbstractAxisParameter
-
- All Implemented Interfaces:
Axis,de.gsi.dataset.AxisDescription,de.gsi.dataset.event.EventSource,javafx.css.Styleable,javafx.event.EventTarget
- Direct Known Subclasses:
AbstractAxis
public abstract class AbstractAxisParameter extends javafx.scene.layout.Pane implements Axis
Class containing the properties, getters and setters for the AbstractNumericAxis classintention is to move the boiler-plate code here for better readability of the AbstractNumericAxis class
- Author:
- rstein
-
-
Field Summary
Fields Modifier and Type Field Description protected AxisRangeautoRangeif available (last) auto-range that has been computedprotected AxisLabelaxisLabelprotected static intDEFAULT_MINOR_TICK_COUNTprotected booleanisInvertedAxisprotected booleanisTimeAxisprotected javafx.collections.ObservableList<TickMark>majorTickMarksprotected javafx.scene.shape.PathmajorTickStylePaths used for css-type styling.protected javafx.beans.property.DoublePropertymaxPropThe value for the upper bound of this axis, ie max value.protected booleanmeasureInvalidprotected javafx.collections.ObservableList<TickMark>minorTickMarksprotected javafx.scene.shape.PathminorTickStyleprotected javafx.beans.property.DoublePropertyminPropThe value for the lower bound of this axis, ie min value.protected doubleoldAxisLengthThis is the minimum/maximum current data value and it is used while auto ranging.protected booleanrangeValidprotected javafx.beans.property.DoublePropertyscaleBindingUsed to update scale property in AbstractAxisParameter (that is read-only) TODO: remove is possibleprotected javafx.beans.property.DoublePropertytickLabelRotationRotation in degrees of tick mark labels from their normal horizontal.protected booleantickLabelsVisibleInvalidprotected javafx.css.SimpleStyleableDoublePropertytickUnitprotected AxisRangeuserRangeuser-specified range (ie.
-
Constructor Summary
Constructors Constructor Description AbstractAxisParameter()Create a auto-ranging AbstractAxisParameter
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description booleanadd(double value)booleanadd(double[] values, int nlength)javafx.beans.property.BooleanPropertyanimatedProperty()javafx.beans.property.IntegerPropertyanimationDurationProperty()javafx.beans.property.BooleanPropertyautoGrowRangingProperty()This is true when the axis determines its range from the data automaticallyjava.util.concurrent.atomic.AtomicBooleanautoNotification()javafx.beans.property.DoublePropertyautoRangePaddingProperty()Fraction of the range to be applied as padding on both sides of the axis range.javafx.beans.property.BooleanPropertyautoRangeRoundingProperty()WithautoRangingProperty()on, defines if the range should be extended to the major tick unit value.javafx.beans.property.BooleanPropertyautoRangingProperty()This is true when the axis determines its range from the data automaticallyjavafx.beans.property.BooleanPropertyautoUnitScalingProperty()javafx.beans.property.DoublePropertyaxisLabelGapProperty()javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment>axisLabelTextAlignmentProperty()javafx.beans.property.DoublePropertyaxisPaddingProperty()javafx.beans.property.DoublePropertycenterAxisPositionProperty()booleanclear()booleancontains(double value)protected doubledecadeRange()abstract voidfireInvalidated()javafx.scene.text.TextAlignmentgetaAxisLabelTextAlignment()intgetAnimationDuration()AxisRangegetAutoRange()if available (last) auto-range that has been computeddoublegetAutoRangePadding()Returns the value of theautoRangePaddingProperty().javafx.scene.text.TextgetAxisLabel()doublegetAxisLabelGap()doublegetAxisPadding()doublegetCenterAxisPosition()static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>getClassCssMetaData()java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>getCssMetaData()doublegetLength()javafx.scene.shape.PathgetMajorTickStyle()doublegetMax()intgetMaxMaxjorTickLabelCount()doublegetMin()intgetMinorTickCount()doublegetMinorTickLength()javafx.collections.ObservableList<TickMark>getMinorTickMarks()javafx.scene.shape.PathgetMinorTickStyle()java.lang.StringgetName()AxisLabelOverlapPolicygetOverlapPolicy()AxisRangegetRange()on auto-ranging this returns getAutoRange(), otherwise the user-specified range getUserRange() (ie.doublegetScale()SidegetSide()javafx.scene.paint.PaintgetTickLabelFill()javafx.scene.text.FontgetTickLabelFont()javafx.util.StringConverter<java.lang.Number>getTickLabelFormatter()doublegetTickLabelGap()doublegetTickLabelRotation()doublegetTickLength()javafx.collections.ObservableList<TickMark>getTickMarks()doublegetTickUnit()Returns tick unit value expressed in data units.java.lang.StringgetUnit()doublegetUnitScaling()AxisRangegetUserRange()user-specified range (ie.protected voidinvalidateRange()Mark the current range invalid, this will cause anything that depends on the range to be recalculated on the next layout.voidinvertAxis(boolean value)This istruewhen the axis labels and data point order should be invertedjavafx.beans.property.BooleanPropertyinvertAxisProperty()This istruewhen the axis labels and data point order should be invertedvoidinvokeListener(de.gsi.dataset.event.UpdateEvent updateEvent, boolean executeParallel)invoke object within update listener listbooleanisAnimated()Indicates whether the changes to axis range will be animated or not.booleanisAutoGrowRanging()This is true when the axis determines its range from the data automatically and grows it if necessarybooleanisAutoRangeRounding()Returns the value of theautoRangeRoundingProperty().booleanisAutoRanging()This is true when the axis determines its range from the data automaticallybooleanisAutoUnitScaling()booleanisDefined()booleanisInvertedAxis()This istruewhen the axis labels and data point order should be invertedbooleanisMinorTickVisible()booleanisTickLabelsVisible()booleanisTickMarkVisible()booleanisTimeAxis()This is true when the axis corresponds to a time-axisjavafx.beans.property.IntegerPropertymaxMajorTickLabelCountProperty()javafx.beans.property.DoublePropertymaxProperty()javafx.beans.property.IntegerPropertyminorTickCountProperty()javafx.beans.property.DoublePropertyminorTickLengthProperty()javafx.beans.property.BooleanPropertyminorTickVisibleProperty()javafx.beans.property.DoublePropertyminProperty()javafx.beans.property.StringPropertynameProperty()javafx.beans.property.ObjectProperty<AxisLabelOverlapPolicy>overlapPolicyProperty()javafx.beans.property.ReadOnlyDoublePropertyscaleProperty()booleanset(double min, double max)booleanset(java.lang.String axisName, java.lang.String... axisUnit)booleanset(java.lang.String axisName, java.lang.String axisUnit, double rangeMin, double rangeMax)voidsetAnimated(boolean value)voidsetAnimationDuration(int value)voidsetAutoGrowRanging(boolean state)This is true when the axis determines its range from the data automatically and grows it if necessaryvoidsetAutoRangePadding(double padding)Sets the value of theautoRangePaddingProperty()voidsetAutoRangeRounding(boolean round)Sets the value of theautoRangeRoundingProperty()voidsetAutoRanging(boolean value)This is true when the axis determines its range from the data automaticallyvoidsetAutoUnitScaling(boolean value)voidsetAxisCentrePosition(double value)voidsetAxisLabelAlignment(javafx.scene.text.TextAlignment value)voidsetAxisLabelGap(double value)voidsetAxisPadding(double value)booleansetMax(double value)voidsetMaxMajorTickLabelCount(int value)booleansetMin(double value)voidsetMinorTickCount(int value)voidsetMinorTickLength(double value)voidsetMinorTickVisible(boolean value)voidsetName(java.lang.String value)voidsetOverlapPolicy(AxisLabelOverlapPolicy value)protected voidsetScale(double scale)voidsetSide(Side value)voidsetTickLabelFill(javafx.scene.paint.Paint value)voidsetTickLabelFont(javafx.scene.text.Font value)voidsetTickLabelFormatter(javafx.util.StringConverter<java.lang.Number> value)voidsetTickLabelGap(double value)voidsetTickLabelRotation(double value)voidsetTickLabelsVisible(boolean value)voidsetTickLength(double value)voidsetTickMarkVisible(boolean value)voidsetTickUnit(double unit)Sets the value of thetickUnitProperty().voidsetTimeAxis(boolean value)This istruewhen the axis labels and data point should be plotted according to some time-axis definitionvoidsetUnit(java.lang.String value)voidsetUnitScaling(double value)voidsetUnitScaling(MetricPrefix prefix)javafx.beans.property.ObjectProperty<Side>sideProperty()javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint>tickLabelFillProperty()javafx.beans.property.ObjectProperty<javafx.scene.text.Font>tickLabelFontProperty()javafx.beans.property.ObjectProperty<javafx.util.StringConverter<java.lang.Number>>tickLabelFormatterProperty()javafx.beans.property.DoublePropertytickLabelGapProperty()javafx.beans.property.DoublePropertytickLabelRotationProperty()javafx.beans.property.BooleanPropertytickLabelsVisibleProperty()javafx.beans.property.DoublePropertytickLengthProperty()javafx.beans.property.BooleanPropertytickMarkVisibleProperty()javafx.beans.property.DoublePropertytickUnitProperty()The value between each major tick mark in data units.javafx.beans.property.BooleanPropertytimeAxisProperty()This istruewhen the axis labels and data point should be plotted according to some time-axis definitionjavafx.beans.property.ObjectProperty<java.lang.String>unitProperty()javafx.beans.property.DoublePropertyunitScalingProperty()protected voidupdateAxisLabelAndUnit()java.util.List<de.gsi.dataset.event.EventListener>updateEventListener()protected voidupdateScaleAndUnitPrefix()-
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
-
Methods inherited from class javafx.scene.Parent
getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, 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, 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, getInitialCursor, getInitialFocusTraversable, 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, getViewOrder, hasProperties, hoverProperty, idProperty, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, 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
drawAxis, forceRedraw, getAxisTransform, getDisplayPosition, getHeight, getLogAxisType, getTickMarkLabel, getValueForDisplay, getWidth, getZeroPosition, invalidateRange, isLogAxis, isValueOnAxis, requestAxisLayout
-
-
-
-
Field Detail
-
DEFAULT_MINOR_TICK_COUNT
protected static final int DEFAULT_MINOR_TICK_COUNT
- See Also:
- Constant Field Values
-
majorTickStyle
protected final javafx.scene.shape.Path majorTickStyle
Paths used for css-type styling. Not used for actual drawing. Used as a storage contained for the settings applied to GraphicsContext which allow much faster (and less complex) drawing routines but do no not allow CSS-type styling.
-
minorTickStyle
protected final javafx.scene.shape.Path minorTickStyle
-
axisLabel
protected final AxisLabel axisLabel
-
oldAxisLength
protected double oldAxisLength
This is the minimum/maximum current data value and it is used while auto ranging. Package private solely for test purposes TODO: replace concept with 'actual range', 'user-defined range', 'auto-range' (+min, max range limit for auto).... actual is used to compute tick marks and defined by either user or auto (ie. auto axis is always being computed), ALSO add maybe a zoom range (ie. limited by user-set/auto-range range)
-
rangeValid
protected boolean rangeValid
-
measureInvalid
protected boolean measureInvalid
-
tickLabelsVisibleInvalid
protected boolean tickLabelsVisibleInvalid
-
majorTickMarks
protected final javafx.collections.ObservableList<TickMark> majorTickMarks
-
minorTickMarks
protected final javafx.collections.ObservableList<TickMark> minorTickMarks
-
autoRange
protected AxisRange autoRange
if available (last) auto-range that has been computed
-
userRange
protected AxisRange userRange
user-specified range (ie. limits based on [lower,upper]Bound)
-
tickLabelRotation
protected final javafx.beans.property.DoubleProperty tickLabelRotation
Rotation in degrees of tick mark labels from their normal horizontal.
-
maxProp
protected final javafx.beans.property.DoubleProperty maxProp
The value for the upper bound of this axis, ie max value. This is automatically set if auto ranging is on.
-
minProp
protected final javafx.beans.property.DoubleProperty minProp
The value for the lower bound of this axis, ie min value. This is automatically set if auto ranging is on.
-
scaleBinding
protected final javafx.beans.property.DoubleProperty scaleBinding
Used to update scale property in AbstractAxisParameter (that is read-only) TODO: remove is possible
-
isInvertedAxis
protected boolean isInvertedAxis
-
isTimeAxis
protected boolean isTimeAxis
-
tickUnit
protected final javafx.css.SimpleStyleableDoubleProperty tickUnit
-
-
Method Detail
-
add
public boolean add(double value)
- Specified by:
addin interfacede.gsi.dataset.AxisDescription
-
add
public boolean add(double[] values, int nlength)- Specified by:
addin interfacede.gsi.dataset.AxisDescription
-
animatedProperty
public javafx.beans.property.BooleanProperty animatedProperty()
-
animationDurationProperty
public javafx.beans.property.IntegerProperty animationDurationProperty()
-
autoGrowRangingProperty
public javafx.beans.property.BooleanProperty autoGrowRangingProperty()
This is true when the axis determines its range from the data automatically- Specified by:
autoGrowRangingPropertyin interfaceAxis- Returns:
- property
-
autoNotification
public java.util.concurrent.atomic.AtomicBoolean autoNotification()
- Specified by:
autoNotificationin interfacede.gsi.dataset.event.EventSource
-
autoRangePaddingProperty
public javafx.beans.property.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].- Returns:
- autoRangePadding property
-
autoRangeRoundingProperty
public javafx.beans.property.BooleanProperty autoRangeRoundingProperty()
WithautoRangingProperty()on, defines if the range should be extended to the major tick unit value. For example with range [3, 74] and major tick unit [5], the range will be extended to [0, 75].Default value:
true- Returns:
- autoRangeRounding property
-
autoRangingProperty
public javafx.beans.property.BooleanProperty autoRangingProperty()
Description copied from interface:AxisThis is true when the axis determines its range from the data automatically- Specified by:
autoRangingPropertyin interfaceAxis- Returns:
- property
-
autoUnitScalingProperty
public javafx.beans.property.BooleanProperty autoUnitScalingProperty()
- Specified by:
autoUnitScalingPropertyin interfaceAxis- Returns:
true-> scale to the nearest SI unit prefix
-
axisLabelGapProperty
public javafx.beans.property.DoubleProperty axisLabelGapProperty()
-
axisLabelTextAlignmentProperty
public javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment> axisLabelTextAlignmentProperty()
-
axisPaddingProperty
public javafx.beans.property.DoubleProperty axisPaddingProperty()
-
centerAxisPositionProperty
public javafx.beans.property.DoubleProperty centerAxisPositionProperty()
-
clear
public boolean clear()
- Specified by:
clearin interfacede.gsi.dataset.AxisDescription
-
contains
public boolean contains(double value)
- Specified by:
containsin interfacede.gsi.dataset.AxisDescription
-
fireInvalidated
public abstract void fireInvalidated()
-
getaAxisLabelTextAlignment
public javafx.scene.text.TextAlignment getaAxisLabelTextAlignment()
-
getAnimationDuration
public int getAnimationDuration()
-
getAutoRange
public AxisRange getAutoRange()
Description copied from interface:Axisif available (last) auto-range that has been computed- Specified by:
getAutoRangein interfaceAxis- Returns:
- computed auto-range
-
getAutoRangePadding
public double getAutoRangePadding()
Returns the value of theautoRangePaddingProperty().- Returns:
- the auto range padding
-
getAxisLabel
public javafx.scene.text.Text getAxisLabel()
- Returns:
- the axisLabel
-
getAxisLabelGap
public double getAxisLabelGap()
-
getAxisPadding
public double getAxisPadding()
-
getCenterAxisPosition
public double getCenterAxisPosition()
-
getCssMetaData
public java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getCssMetaData()
- Specified by:
getCssMetaDatain interfacejavafx.css.Styleable- Overrides:
getCssMetaDatain classjavafx.scene.layout.Region
-
getLength
public double getLength()
-
getMajorTickStyle
public javafx.scene.shape.Path getMajorTickStyle()
- Returns:
- the majorTickStyle for custom user-code based styling
-
getMax
public double getMax()
- Specified by:
getMaxin interfacede.gsi.dataset.AxisDescription
-
getMaxMaxjorTickLabelCount
public int getMaxMaxjorTickLabelCount()
-
getMin
public double getMin()
- Specified by:
getMinin interfacede.gsi.dataset.AxisDescription
-
getMinorTickCount
public int getMinorTickCount()
- Specified by:
getMinorTickCountin interfaceAxis
-
getMinorTickLength
public double getMinorTickLength()
-
getMinorTickMarks
public javafx.collections.ObservableList<TickMark> getMinorTickMarks()
- Specified by:
getMinorTickMarksin interfaceAxis- Returns:
- observable list containing of each minor TickMark on this axis
-
getMinorTickStyle
public javafx.scene.shape.Path getMinorTickStyle()
- Returns:
- the minorTickStyle for custom user-code based styling
-
getName
public java.lang.String getName()
- Specified by:
getNamein interfacede.gsi.dataset.AxisDescription
-
getOverlapPolicy
public AxisLabelOverlapPolicy getOverlapPolicy()
-
getRange
public AxisRange getRange()
on auto-ranging this returns getAutoRange(), otherwise the user-specified range getUserRange() (ie. limits based on [lower,upper]Bound)
-
getScale
public double getScale()
-
getTickLabelFill
public javafx.scene.paint.Paint getTickLabelFill()
- Specified by:
getTickLabelFillin interfaceAxis- Returns:
- the fill for all tick labels
-
getTickLabelFont
public javafx.scene.text.Font getTickLabelFont()
- Specified by:
getTickLabelFontin interfaceAxis- Returns:
- the font for all tick labels
-
getTickLabelFormatter
public javafx.util.StringConverter<java.lang.Number> getTickLabelFormatter()
- Specified by:
getTickLabelFormatterin interfaceAxis
-
getTickLabelGap
public double getTickLabelGap()
- Specified by:
getTickLabelGapin interfaceAxis- Returns:
- the gap between tick labels and the tick mark lines
-
getTickLabelRotation
public double getTickLabelRotation()
-
getTickLength
public double getTickLength()
-
getTickMarks
public javafx.collections.ObservableList<TickMark> getTickMarks()
- Specified by:
getTickMarksin interfaceAxis- Returns:
- observable list containing of each major TickMark on this axis
-
getTickUnit
public double getTickUnit()
Returns tick unit value expressed in data units.- Specified by:
getTickUnitin interfaceAxis- Returns:
- major tick unit value
-
getUnit
public java.lang.String getUnit()
- Specified by:
getUnitin interfacede.gsi.dataset.AxisDescription
-
getUnitScaling
public double getUnitScaling()
- Specified by:
getUnitScalingin interfaceAxis- Returns:
- axis primary unit scaling
-
getUserRange
public AxisRange getUserRange()
Description copied from interface:Axisuser-specified range (ie. limits based on [lower,upper]Bound)- Specified by:
getUserRangein interfaceAxis- Returns:
- user-specified range
-
invertAxis
public void invertAxis(boolean value)
This istruewhen the axis labels and data point order should be inverted- Specified by:
invertAxisin interfaceAxis- Parameters:
value-trueif axis shall be inverted (i.e. drawn from 'max->min', rather than the normal 'min->max')
-
invertAxisProperty
public javafx.beans.property.BooleanProperty invertAxisProperty()
This istruewhen the axis labels and data point order should be inverted- Specified by:
invertAxisPropertyin interfaceAxis- Returns:
- property
-
invokeListener
public void invokeListener(de.gsi.dataset.event.UpdateEvent updateEvent, boolean executeParallel)invoke object within update listener list- Specified by:
invokeListenerin interfaceAxis- Specified by:
invokeListenerin interfacede.gsi.dataset.event.EventSource- Parameters:
updateEvent- the event the listeners are notified withexecuteParallel-trueexecute event listener via parallel executor service
-
isAnimated
public boolean isAnimated()
Indicates whether the changes to axis range will be animated or not.- Returns:
- true if axis range changes will be animated and false otherwise
-
isAutoGrowRanging
public boolean isAutoGrowRanging()
This is true when the axis determines its range from the data automatically and grows it if necessary- Specified by:
isAutoGrowRangingin interfaceAxis- Returns:
- true if axis shall be updated to the optimal data range
-
isAutoRangeRounding
public boolean isAutoRangeRounding()
Returns the value of theautoRangeRoundingProperty().- Returns:
- the auto range rounding flag
-
isAutoRanging
public boolean isAutoRanging()
Description copied from interface:AxisThis is true when the axis determines its range from the data automatically- Specified by:
isAutoRangingin interfaceAxis- Returns:
- true if axis shall be updated to the optimal data range
-
isAutoUnitScaling
public boolean isAutoUnitScaling()
- Specified by:
isAutoUnitScalingin interfaceAxis- Returns:
- whether unit is automatically adjusted to multiples of 1e3 (kilo, mega, ...) or 1e-3 (milli, micro, ...)
-
isDefined
public boolean isDefined()
- Specified by:
isDefinedin interfacede.gsi.dataset.AxisDescription
-
isInvertedAxis
public boolean isInvertedAxis()
This istruewhen the axis labels and data point order should be inverted- Specified by:
isInvertedAxisin interfaceAxis- Returns:
trueif axis shall be inverted (i.e. drawn from 'max->min', rather than the normal 'min->max')
-
isMinorTickVisible
public boolean isMinorTickVisible()
-
isTickLabelsVisible
public boolean isTickLabelsVisible()
-
isTickMarkVisible
public boolean isTickMarkVisible()
-
isTimeAxis
public boolean isTimeAxis()
This is true when the axis corresponds to a time-axis- Specified by:
isTimeAxisin interfaceAxis- Returns:
- true if axis is a time scale
-
maxMajorTickLabelCountProperty
public javafx.beans.property.IntegerProperty maxMajorTickLabelCountProperty()
-
maxProperty
public javafx.beans.property.DoubleProperty maxProperty()
- Specified by:
maxPropertyin interfaceAxis
-
minorTickCountProperty
public javafx.beans.property.IntegerProperty minorTickCountProperty()
-
minorTickLengthProperty
public javafx.beans.property.DoubleProperty minorTickLengthProperty()
-
minorTickVisibleProperty
public javafx.beans.property.BooleanProperty minorTickVisibleProperty()
-
minProperty
public javafx.beans.property.DoubleProperty minProperty()
- Specified by:
minPropertyin interfaceAxis
-
nameProperty
public javafx.beans.property.StringProperty nameProperty()
- Specified by:
namePropertyin interfaceAxis- Returns:
- the primary axis name/label property
-
overlapPolicyProperty
public javafx.beans.property.ObjectProperty<AxisLabelOverlapPolicy> overlapPolicyProperty()
-
scaleProperty
public javafx.beans.property.ReadOnlyDoubleProperty scaleProperty()
-
set
public boolean set(double min, double max)- Specified by:
setin interfacede.gsi.dataset.AxisDescription
-
set
public boolean set(java.lang.String axisName, java.lang.String... axisUnit)- Specified by:
setin interfacede.gsi.dataset.AxisDescription
-
set
public boolean set(java.lang.String axisName, java.lang.String axisUnit, double rangeMin, double rangeMax)- Specified by:
setin interfacede.gsi.dataset.AxisDescription
-
setAnimated
public void setAnimated(boolean value)
- Specified by:
setAnimatedin interfaceAxis- Parameters:
value- true if axis range changes will be animated and false otherwise
-
setAnimationDuration
public void setAnimationDuration(int value)
-
setAutoGrowRanging
public void setAutoGrowRanging(boolean state)
This is true when the axis determines its range from the data automatically and grows it if necessary- Specified by:
setAutoGrowRangingin interfaceAxis- Parameters:
state- true if axis shall be updated to the optimal data range and grows it if necessary
-
setAutoRangePadding
public void setAutoRangePadding(double padding)
Sets the value of theautoRangePaddingProperty()- Parameters:
padding- padding factor
-
setAutoRangeRounding
public void setAutoRangeRounding(boolean round)
Sets the value of theautoRangeRoundingProperty()- Parameters:
round- iftrue, lower and upper bound will be adjusted to the tick unit value
-
setAutoRanging
public void setAutoRanging(boolean value)
Description copied from interface:AxisThis is true when the axis determines its range from the data automatically- Specified by:
setAutoRangingin interfaceAxis- Parameters:
value- true if axis shall be updated to the optimal data range
-
setAutoUnitScaling
public void setAutoUnitScaling(boolean value)
- Specified by:
setAutoUnitScalingin interfaceAxis- Parameters:
value- scaling valuetrue-> scale to the nearest SI unit prefix
-
setAxisCentrePosition
public void setAxisCentrePosition(double value)
-
setAxisLabelAlignment
public void setAxisLabelAlignment(javafx.scene.text.TextAlignment value)
-
setAxisLabelGap
public void setAxisLabelGap(double value)
-
setAxisPadding
public void setAxisPadding(double value)
-
setMax
public boolean setMax(double value)
- Specified by:
setMaxin interfacede.gsi.dataset.AxisDescription
-
setMaxMajorTickLabelCount
public void setMaxMajorTickLabelCount(int value)
-
setMin
public boolean setMin(double value)
- Specified by:
setMinin interfacede.gsi.dataset.AxisDescription
-
setMinorTickCount
public void setMinorTickCount(int value)
-
setMinorTickLength
public void setMinorTickLength(double value)
-
setMinorTickVisible
public void setMinorTickVisible(boolean value)
-
setName
public void setName(java.lang.String value)
-
setOverlapPolicy
public void setOverlapPolicy(AxisLabelOverlapPolicy value)
-
setTickLabelFill
public void setTickLabelFill(javafx.scene.paint.Paint value)
-
setTickLabelFont
public void setTickLabelFont(javafx.scene.text.Font value)
-
setTickLabelFormatter
public void setTickLabelFormatter(javafx.util.StringConverter<java.lang.Number> value)
-
setTickLabelGap
public void setTickLabelGap(double value)
-
setTickLabelRotation
public void setTickLabelRotation(double value)
-
setTickLabelsVisible
public void setTickLabelsVisible(boolean value)
-
setTickLength
public void setTickLength(double value)
-
setTickMarkVisible
public void setTickMarkVisible(boolean value)
-
setTickUnit
public void setTickUnit(double unit)
Sets the value of thetickUnitProperty().- Specified by:
setTickUnitin interfaceAxis- Parameters:
unit- major tick unit
-
setTimeAxis
public void setTimeAxis(boolean value)
This istruewhen the axis labels and data point should be plotted according to some time-axis definition- Specified by:
setTimeAxisin interfaceAxis- Parameters:
value-trueif axis shall be drawn with time-axis labels
-
setUnit
public void setUnit(java.lang.String value)
-
setUnitScaling
public void setUnitScaling(double value)
- Specified by:
setUnitScalingin interfaceAxis- Parameters:
value- the new axis primary unit label
-
setUnitScaling
public void setUnitScaling(MetricPrefix prefix)
- Specified by:
setUnitScalingin interfaceAxis- Parameters:
prefix- the new axis primary unit label
-
sideProperty
public javafx.beans.property.ObjectProperty<Side> sideProperty()
- Specified by:
sidePropertyin interfaceAxis
-
tickLabelFillProperty
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint> tickLabelFillProperty()
-
tickLabelFontProperty
public javafx.beans.property.ObjectProperty<javafx.scene.text.Font> tickLabelFontProperty()
-
tickLabelFormatterProperty
public javafx.beans.property.ObjectProperty<javafx.util.StringConverter<java.lang.Number>> tickLabelFormatterProperty()
-
tickLabelGapProperty
public javafx.beans.property.DoubleProperty tickLabelGapProperty()
-
tickLabelRotationProperty
public javafx.beans.property.DoubleProperty tickLabelRotationProperty()
-
tickLabelsVisibleProperty
public javafx.beans.property.BooleanProperty tickLabelsVisibleProperty()
-
tickLengthProperty
public javafx.beans.property.DoubleProperty tickLengthProperty()
-
tickMarkVisibleProperty
public javafx.beans.property.BooleanProperty tickMarkVisibleProperty()
-
tickUnitProperty
public javafx.beans.property.DoubleProperty tickUnitProperty()
The value between each major tick mark in data units. This is automatically set if we are auto-ranging.- Specified by:
tickUnitPropertyin interfaceAxis- Returns:
- tickUnit property
-
timeAxisProperty
public javafx.beans.property.BooleanProperty timeAxisProperty()
This istruewhen the axis labels and data point should be plotted according to some time-axis definition- Specified by:
timeAxisPropertyin interfaceAxis- Returns:
- time axis property reference
-
unitProperty
public javafx.beans.property.ObjectProperty<java.lang.String> unitProperty()
- Specified by:
unitPropertyin interfaceAxis- Returns:
- the primary unit name property
-
unitScalingProperty
public javafx.beans.property.DoubleProperty unitScalingProperty()
- Specified by:
unitScalingPropertyin interfaceAxis- Returns:
- the primary unit label property
-
updateEventListener
public java.util.List<de.gsi.dataset.event.EventListener> updateEventListener()
- Specified by:
updateEventListenerin interfacede.gsi.dataset.event.EventSource
-
decadeRange
protected double decadeRange()
-
invalidateRange
protected void invalidateRange()
Mark the current range invalid, this will cause anything that depends on the range to be recalculated on the next layout.
-
setScale
protected void setScale(double scale)
-
updateAxisLabelAndUnit
protected void updateAxisLabelAndUnit()
-
updateScaleAndUnitPrefix
protected void updateScaleAndUnitPrefix()
-
getClassCssMetaData
public static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()
- Returns:
- The CssMetaData associated with this class, which may include the CssMetaData of its super classes.
-
-