Class 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 class

    intention 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 static int DEFAULT_MINOR_TICK_COUNT  
      protected boolean isInvertedAxis  
      protected boolean isTimeAxis  
      protected javafx.collections.ObservableList<TickMark> majorTickMarks  
      protected javafx.collections.ObservableList<java.lang.Double> majorTickMarkValues  
      protected javafx.beans.property.DoubleProperty maxProp
      The value for the upper bound of this axis, ie max value.
      protected javafx.collections.ObservableList<TickMark> minorTickMarks  
      protected javafx.collections.ObservableList<java.lang.Double> minorTickMarkValues  
      protected javafx.beans.property.DoubleProperty minProp
      The value for the lower bound of this axis, ie min value.
      protected double oldAxisLength
      This is the minimum/maximum current data value and it is used while auto ranging.
      protected double oldAxisMax  
      protected double oldAxisMin  
      protected double oldTickUnit  
      protected javafx.beans.property.DoubleProperty scaleBinding
      Used to update scale property in AbstractAxisParameter (that is read-only) TODO: remove is possible
      protected javafx.beans.property.DoubleProperty tickLabelRotation
      Rotation in degrees of tick mark labels from their normal horizontal.
      protected javafx.css.SimpleStyleableDoubleProperty tickUnit  
      protected javafx.beans.property.BooleanProperty valid  
      • 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 Description
      AbstractAxisParameter()
      Create a auto-ranging AbstractAxisParameter
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean add​(double value)  
      boolean add​(double[] values, int nlength)  
      javafx.beans.property.BooleanProperty animatedProperty()  
      javafx.beans.property.IntegerProperty animationDurationProperty()  
      javafx.beans.property.BooleanProperty autoGrowRangingProperty()
      This is true when the axis determines its range from the data automatically
      java.util.concurrent.atomic.AtomicBoolean autoNotification()
      javafx.beans.property.DoubleProperty autoRangePaddingProperty()
      Fraction of the range to be applied as padding on both sides of the axis range.
      javafx.beans.property.BooleanProperty autoRangeRoundingProperty()
      With autoRangingProperty() on, defines if the range should be extended to the major tick unit value.
      javafx.beans.property.BooleanProperty autoRangingProperty()
      This is true when the axis determines its range from the data automatically
      javafx.beans.property.BooleanProperty autoUnitScalingProperty()  
      javafx.beans.property.DoubleProperty axisLabelGapProperty()  
      javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment> axisLabelTextAlignmentProperty()  
      javafx.beans.property.DoubleProperty axisPaddingProperty()  
      javafx.beans.property.DoubleProperty centerAxisPositionProperty()  
      boolean clear()  
      boolean contains​(double value)  
      protected static boolean equalString​(java.lang.String str1, java.lang.String str2)  
      abstract void fireInvalidated()  
      javafx.scene.text.TextAlignment getaAxisLabelTextAlignment()
      Deprecated.
      int getAnimationDuration()  
      AxisRange getAutoRange()
      if available (last) auto-range that has been computed
      double getAutoRangePadding()
      Returns the value of the autoRangePaddingProperty().
      double getAxisCenterPosition()  
      javafx.scene.text.Text getAxisLabel()  
      double getAxisLabelGap()  
      javafx.scene.text.TextAlignment getAxisLabelTextAlignment()  
      double getAxisPadding()  
      double getCenterAxisPosition()
      Deprecated.
      static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,​?>> getClassCssMetaData()  
      java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,​?>> getCssMetaData()
      double getLength()  
      javafx.scene.shape.Path getMajorTickStyle()  
      double getMax()  
      int getMaxMajorTickLabelCount()  
      int getMaxMaxjorTickLabelCount()
      Deprecated.
      double getMin()  
      int getMinorTickCount()  
      double getMinorTickLength()  
      javafx.collections.ObservableList<TickMark> getMinorTickMarks()  
      javafx.collections.ObservableList<java.lang.Double> getMinorTickMarkValues()  
      javafx.scene.shape.Path getMinorTickStyle()  
      java.lang.String getName()  
      AxisLabelOverlapPolicy getOverlapPolicy()  
      AxisRange getRange()
      on auto-ranging this returns getAutoRange(), otherwise the user-specified range getUserRange() (ie.
      double getScale()  
      Side getSide()  
      javafx.scene.paint.Paint getTickLabelFill()  
      javafx.scene.text.Font getTickLabelFont()  
      javafx.util.StringConverter<java.lang.Number> getTickLabelFormatter()  
      double getTickLabelGap()  
      double getTickLabelRotation()  
      double getTickLabelSpacing()  
      double getTickLength()  
      javafx.collections.ObservableList<TickMark> getTickMarks()  
      javafx.collections.ObservableList<java.lang.Double> getTickMarkValues()  
      double getTickUnit()
      Returns tick unit value expressed in data units.
      java.lang.String getUnit()  
      double getUnitScaling()  
      AxisRange getUserRange()
      user-specified range (ie.
      void invalidate()
      Mark the current axis invalid, this will cause anything that depends on the axis range or physical size to be recalculated on the next layout iteration.
      void invertAxis​(boolean value)
      This is true when the axis labels and data point order should be inverted
      javafx.beans.property.BooleanProperty invertAxisProperty()
      This is true when the axis labels and data point order should be inverted
      void invokeListener​(de.gsi.dataset.event.UpdateEvent updateEvent, boolean executeParallel)
      invoke object within update listener list
      boolean isAnimated()  
      boolean isAutoGrowRanging()
      This is true when the axis determines its range from the data automatically and grows it if necessary
      boolean isAutoRangeRounding()
      Returns the value of the autoRangeRoundingProperty().
      boolean isAutoRanging()
      This is true when the axis determines its range from the data automatically
      boolean isAutoUnitScaling()  
      boolean isDefined()  
      boolean isInvertedAxis()
      This is true when the axis labels and data point order should be inverted
      boolean isMinorTickVisible()  
      boolean isTickLabelsVisible()  
      boolean isTickMarkVisible()  
      boolean isTimeAxis()
      This is true when the axis corresponds to a time-axis
      boolean isValid()  
      javafx.beans.property.IntegerProperty maxMajorTickLabelCountProperty()  
      javafx.beans.property.DoubleProperty maxProperty()  
      javafx.beans.property.IntegerProperty minorTickCountProperty()  
      javafx.beans.property.DoubleProperty minorTickLengthProperty()  
      javafx.beans.property.BooleanProperty minorTickVisibleProperty()  
      javafx.beans.property.DoubleProperty minProperty()  
      javafx.beans.property.StringProperty nameProperty()  
      javafx.beans.property.ObjectProperty<AxisLabelOverlapPolicy> overlapPolicyProperty()  
      javafx.beans.property.ReadOnlyDoubleProperty scaleProperty()  
      boolean set​(double min, double max)  
      boolean set​(java.lang.String axisName, java.lang.String... axisUnit)  
      boolean set​(java.lang.String axisName, java.lang.String axisUnit, double rangeMin, double rangeMax)  
      void setAnimated​(boolean value)
      Sets animatedProperty() property
      void setAnimationDuration​(int value)
      Sets the value of the animationDurationProperty() property
      void setAutoGrowRanging​(boolean state)
      Sets the value of the autoGrowRangingProperty() property
      void setAutoRangePadding​(double padding)
      Sets the value of the autoRangePaddingProperty()
      void setAutoRangeRounding​(boolean round)
      Sets the value of the autoRangeRoundingProperty()
      void setAutoRanging​(boolean value)
      This is true when the axis determines its range from the data automatically
      void setAutoUnitScaling​(boolean value)  
      void setAxisCenterPosition​(double value)  
      void setAxisLabelGap​(double value)  
      void setAxisLabelTextAlignment​(javafx.scene.text.TextAlignment value)  
      void setAxisPadding​(double value)  
      boolean setMax​(double value)  
      void setMaxMajorTickLabelCount​(int value)  
      boolean setMin​(double value)  
      void setMinorTickCount​(int value)  
      void setMinorTickLength​(double value)  
      void setMinorTickVisible​(boolean value)  
      void setName​(java.lang.String value)  
      void setOverlapPolicy​(AxisLabelOverlapPolicy value)  
      protected void setScale​(double scale)  
      void setSide​(Side value)  
      void setTickLabelFill​(javafx.scene.paint.Paint value)  
      void setTickLabelFont​(javafx.scene.text.Font value)  
      void setTickLabelFormatter​(javafx.util.StringConverter<java.lang.Number> value)  
      void setTickLabelGap​(double value)  
      void setTickLabelRotation​(double value)  
      void setTickLabelSpacing​(double value)  
      void setTickLabelsVisible​(boolean value)  
      void setTickLength​(double value)  
      void setTickMarkVisible​(boolean value)  
      void setTickUnit​(double unit)
      Sets the value of the tickUnitProperty().
      void setTimeAxis​(boolean value)
      This is true when the axis labels and data point should be plotted according to some time-axis definition
      void setUnit​(java.lang.String value)  
      void setUnitScaling​(double value)  
      void setUnitScaling​(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.DoubleProperty tickLabelGapProperty()  
      javafx.beans.property.DoubleProperty tickLabelRotationProperty()  
      javafx.beans.property.DoubleProperty tickLabelSpacing()  
      javafx.beans.property.BooleanProperty tickLabelsVisibleProperty()  
      javafx.beans.property.DoubleProperty tickLengthProperty()  
      javafx.beans.property.BooleanProperty tickMarkVisibleProperty()  
      javafx.beans.property.DoubleProperty tickUnitProperty()
      The value between each major tick mark in data units.
      javafx.beans.property.BooleanProperty timeAxisProperty()
      This is true when the axis labels and data point should be plotted according to some time-axis definition
      javafx.beans.property.ObjectProperty<java.lang.String> unitProperty()  
      javafx.beans.property.DoubleProperty unitScalingProperty()  
      protected void updateAxisLabelAndUnit()  
      java.util.List<de.gsi.dataset.event.EventListener> updateEventListener()
      protected void updateScaleAndUnitPrefix()  
      protected javafx.beans.property.BooleanProperty validProperty()
      valid flag property.
      • 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, 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.dataset.AxisDescription

        add, set
      • Methods inherited from interface de.gsi.dataset.event.EventSource

        addListener, invokeListener, invokeListener, isAutoNotification, removeListener
      • Methods inherited from interface javafx.css.Styleable

        getStyleableNode
    • Field Detail

      • DEFAULT_MINOR_TICK_COUNT

        protected static final int DEFAULT_MINOR_TICK_COUNT
        See Also:
        Constant Field Values
      • 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)
      • oldAxisMin

        protected double oldAxisMin
      • oldAxisMax

        protected double oldAxisMax
      • oldTickUnit

        protected double oldTickUnit
      • valid

        protected javafx.beans.property.BooleanProperty valid
      • majorTickMarkValues

        protected final javafx.collections.ObservableList<java.lang.Double> majorTickMarkValues
      • minorTickMarkValues

        protected final javafx.collections.ObservableList<java.lang.Double> minorTickMarkValues
      • majorTickMarks

        protected final javafx.collections.ObservableList<TickMark> majorTickMarks
      • minorTickMarks

        protected final javafx.collections.ObservableList<TickMark> minorTickMarks
      • 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
    • Constructor Detail

      • AbstractAxisParameter

        public AbstractAxisParameter()
        Create a auto-ranging AbstractAxisParameter
    • Method Detail

      • add

        public boolean add​(double value)
        Specified by:
        add in interface de.gsi.dataset.AxisDescription
      • add

        public boolean add​(double[] values,
                           int nlength)
        Specified by:
        add in interface de.gsi.dataset.AxisDescription
      • animatedProperty

        public javafx.beans.property.BooleanProperty animatedProperty()
        Returns:
        animatedProperty() property
      • animationDurationProperty

        public javafx.beans.property.IntegerProperty animationDurationProperty()
        Returns:
        animationDurationProperty() property
      • autoGrowRangingProperty

        public javafx.beans.property.BooleanProperty autoGrowRangingProperty()
        This is true when the axis determines its range from the data automatically
        Specified by:
        autoGrowRangingProperty in interface Axis
        Returns:
        autoGrowRangingProperty() property
      • autoNotification

        public java.util.concurrent.atomic.AtomicBoolean autoNotification()
        Specified by:
        autoNotification in interface de.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()
        With autoRangingProperty() 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: Axis
        This is true when the axis determines its range from the data automatically
        Specified by:
        autoRangingProperty in interface Axis
        Returns:
        property
      • autoUnitScalingProperty

        public javafx.beans.property.BooleanProperty autoUnitScalingProperty()
        Specified by:
        autoUnitScalingProperty in interface Axis
        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:
        clear in interface de.gsi.dataset.AxisDescription
      • contains

        public boolean contains​(double value)
        Specified by:
        contains in interface de.gsi.dataset.AxisDescription
      • fireInvalidated

        public abstract void fireInvalidated()
      • getaAxisLabelTextAlignment

        @Deprecated
        public javafx.scene.text.TextAlignment getaAxisLabelTextAlignment()
        Deprecated.
      • getAutoRange

        public AxisRange getAutoRange()
        Description copied from interface: Axis
        if available (last) auto-range that has been computed
        Specified by:
        getAutoRange in interface Axis
        Returns:
        computed auto-range
      • getAutoRangePadding

        public double getAutoRangePadding()
        Returns the value of the autoRangePaddingProperty().
        Returns:
        the auto range padding
      • getAxisCenterPosition

        public double getAxisCenterPosition()
      • getAxisLabel

        public javafx.scene.text.Text getAxisLabel()
        Returns:
        the axisLabel
      • getAxisLabelGap

        public double getAxisLabelGap()
      • getAxisLabelTextAlignment

        public javafx.scene.text.TextAlignment getAxisLabelTextAlignment()
      • getAxisPadding

        public double getAxisPadding()
      • getCenterAxisPosition

        @Deprecated
        public double getCenterAxisPosition()
        Deprecated.
      • getCssMetaData

        public java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,​?>> getCssMetaData()
        Specified by:
        getCssMetaData in interface javafx.css.Styleable
        Overrides:
        getCssMetaData in class javafx.scene.layout.Region
      • getLength

        public double getLength()
        Specified by:
        getLength in interface Axis
        Specified by:
        getLength in interface de.gsi.dataset.AxisDescription
        Returns:
        axis length in pixel
      • getMajorTickStyle

        public javafx.scene.shape.Path getMajorTickStyle()
        Returns:
        the majorTickStyle for custom user-code based styling
      • getMax

        public double getMax()
        Specified by:
        getMax in interface de.gsi.dataset.AxisDescription
      • getMaxMajorTickLabelCount

        public int getMaxMajorTickLabelCount()
      • getMaxMaxjorTickLabelCount

        @Deprecated
        public int getMaxMaxjorTickLabelCount()
        Deprecated.
      • getMin

        public double getMin()
        Specified by:
        getMin in interface de.gsi.dataset.AxisDescription
      • getMinorTickLength

        public double getMinorTickLength()
      • getMinorTickMarks

        public javafx.collections.ObservableList<TickMark> getMinorTickMarks()
        Specified by:
        getMinorTickMarks in interface Axis
        Returns:
        observable list containing of each minor TickMark on this axis
      • getMinorTickMarkValues

        public javafx.collections.ObservableList<java.lang.Double> getMinorTickMarkValues()
        Returns:
        observable list containing of each minor TickMark values 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:
        getName in interface de.gsi.dataset.AxisDescription
      • getRange

        public AxisRange getRange()
        on auto-ranging this returns getAutoRange(), otherwise the user-specified range getUserRange() (ie. limits based on [lower,upper]Bound)
        Specified by:
        getRange in interface Axis
        Returns:
        actual range that is being used.
      • getScale

        public double getScale()
      • getSide

        public Side getSide()
        Specified by:
        getSide in interface Axis
        Returns:
        the layout side
      • getTickLabelFill

        public javafx.scene.paint.Paint getTickLabelFill()
        Specified by:
        getTickLabelFill in interface Axis
        Returns:
        the fill for all tick labels
      • getTickLabelFont

        public javafx.scene.text.Font getTickLabelFont()
        Specified by:
        getTickLabelFont in interface Axis
        Returns:
        the font for all tick labels
      • getTickLabelFormatter

        public javafx.util.StringConverter<java.lang.Number> getTickLabelFormatter()
        Specified by:
        getTickLabelFormatter in interface Axis
      • getTickLabelGap

        public double getTickLabelGap()
        Specified by:
        getTickLabelGap in interface Axis
        Returns:
        the gap between tick labels and the tick mark lines
      • getTickLabelRotation

        public double getTickLabelRotation()
      • getTickLabelSpacing

        public double getTickLabelSpacing()
        Specified by:
        getTickLabelSpacing in interface Axis
        Returns:
        the minimum gap between tick labels
      • getTickLength

        public double getTickLength()
      • getTickMarks

        public javafx.collections.ObservableList<TickMark> getTickMarks()
        Specified by:
        getTickMarks in interface Axis
        Returns:
        observable list containing of each major TickMark on this axis
      • getTickMarkValues

        public javafx.collections.ObservableList<java.lang.Double> getTickMarkValues()
        Returns:
        observable list containing of each major TickMark values on this axis
      • getTickUnit

        public double getTickUnit()
        Returns tick unit value expressed in data units.
        Specified by:
        getTickUnit in interface Axis
        Returns:
        major tick unit value
      • getUnit

        public java.lang.String getUnit()
        Specified by:
        getUnit in interface de.gsi.dataset.AxisDescription
      • getUnitScaling

        public double getUnitScaling()
        Specified by:
        getUnitScaling in interface Axis
        Returns:
        axis primary unit scaling
      • getUserRange

        public AxisRange getUserRange()
        Description copied from interface: Axis
        user-specified range (ie. limits based on [lower,upper]Bound)
        Specified by:
        getUserRange in interface Axis
        Returns:
        user-specified range
      • invalidate

        public void invalidate()
        Mark the current axis invalid, this will cause anything that depends on the axis range or physical size to be recalculated on the next layout iteration.
      • invertAxis

        public void invertAxis​(boolean value)
        This is true when the axis labels and data point order should be inverted
        Specified by:
        invertAxis in interface Axis
        Parameters:
        value - true if axis shall be inverted (i.e. drawn from 'max->min', rather than the normal 'min->max')
      • invertAxisProperty

        public javafx.beans.property.BooleanProperty invertAxisProperty()
        This is true when the axis labels and data point order should be inverted
        Specified by:
        invertAxisProperty in interface Axis
        Returns:
        property
      • invokeListener

        public void invokeListener​(de.gsi.dataset.event.UpdateEvent updateEvent,
                                   boolean executeParallel)
        invoke object within update listener list
        Specified by:
        invokeListener in interface Axis
        Specified by:
        invokeListener in interface de.gsi.dataset.event.EventSource
        Parameters:
        updateEvent - the event the listeners are notified with
        executeParallel - true execute event listener via parallel executor service
      • isAutoGrowRanging

        public boolean isAutoGrowRanging()
        This is true when the axis determines its range from the data automatically and grows it if necessary
        Specified by:
        isAutoGrowRanging in interface Axis
        Returns:
        value of the autoGrowRangingProperty() property
      • isAutoRangeRounding

        public boolean isAutoRangeRounding()
        Returns the value of the autoRangeRoundingProperty().
        Returns:
        the auto range rounding flag
      • isAutoRanging

        public boolean isAutoRanging()
        Description copied from interface: Axis
        This is true when the axis determines its range from the data automatically
        Specified by:
        isAutoRanging in interface Axis
        Returns:
        true if axis shall be updated to the optimal data range
      • isAutoUnitScaling

        public boolean isAutoUnitScaling()
        Specified by:
        isAutoUnitScaling in interface Axis
        Returns:
        whether unit is automatically adjusted to multiples of 1e3 (kilo, mega, ...) or 1e-3 (milli, micro, ...)
      • isDefined

        public boolean isDefined()
        Specified by:
        isDefined in interface de.gsi.dataset.AxisDescription
      • isInvertedAxis

        public boolean isInvertedAxis()
        This is true when the axis labels and data point order should be inverted
        Specified by:
        isInvertedAxis in interface Axis
        Returns:
        true if 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:
        isTimeAxis in interface Axis
        Returns:
        true if axis is a time scale
      • isValid

        public boolean isValid()
        Returns:
        true if current axis range and physical size calculations are valid
      • maxMajorTickLabelCountProperty

        public javafx.beans.property.IntegerProperty maxMajorTickLabelCountProperty()
      • maxProperty

        public javafx.beans.property.DoubleProperty maxProperty()
        Specified by:
        maxProperty in interface Axis
      • 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:
        minProperty in interface Axis
      • nameProperty

        public javafx.beans.property.StringProperty nameProperty()
        Specified by:
        nameProperty in interface Axis
        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:
        set in interface de.gsi.dataset.AxisDescription
      • set

        public boolean set​(java.lang.String axisName,
                           java.lang.String... axisUnit)
        Specified by:
        set in interface de.gsi.dataset.AxisDescription
      • set

        public boolean set​(java.lang.String axisName,
                           java.lang.String axisUnit,
                           double rangeMin,
                           double rangeMax)
        Specified by:
        set in interface de.gsi.dataset.AxisDescription
      • setAnimated

        public void setAnimated​(boolean value)
        Sets animatedProperty() property
        Specified by:
        setAnimated in interface Axis
        Parameters:
        value - true if axis range changes will be animated and false otherwise
      • setAnimationDuration

        public void setAnimationDuration​(int value)
        Sets the value of the animationDurationProperty() property
        Parameters:
        value - animation duration in milliseconds
      • setAutoGrowRanging

        public void setAutoGrowRanging​(boolean state)
        Sets the value of the autoGrowRangingProperty() property
        Specified by:
        setAutoGrowRanging in interface Axis
        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 the autoRangePaddingProperty()
        Parameters:
        padding - padding factor
      • setAutoRangeRounding

        public void setAutoRangeRounding​(boolean round)
        Sets the value of the autoRangeRoundingProperty()
        Parameters:
        round - if true, lower and upper bound will be adjusted to the tick unit value
      • setAutoRanging

        public void setAutoRanging​(boolean value)
        Description copied from interface: Axis
        This is true when the axis determines its range from the data automatically
        Specified by:
        setAutoRanging in interface Axis
        Parameters:
        value - true if axis shall be updated to the optimal data range
      • setAutoUnitScaling

        public void setAutoUnitScaling​(boolean value)
        Specified by:
        setAutoUnitScaling in interface Axis
        Parameters:
        value - scaling value true -> scale to the nearest SI unit prefix
      • setAxisCenterPosition

        public void setAxisCenterPosition​(double value)
      • setAxisLabelGap

        public void setAxisLabelGap​(double value)
      • setAxisLabelTextAlignment

        public void setAxisLabelTextAlignment​(javafx.scene.text.TextAlignment value)
      • setAxisPadding

        public void setAxisPadding​(double value)
      • setMax

        public boolean setMax​(double value)
        Specified by:
        setMax in interface de.gsi.dataset.AxisDescription
      • setMaxMajorTickLabelCount

        public void setMaxMajorTickLabelCount​(int value)
      • setMin

        public boolean setMin​(double value)
        Specified by:
        setMin in interface de.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)
        Specified by:
        setName in interface Axis
        Parameters:
        value - the new axis primary label
      • setSide

        public void setSide​(Side value)
        Specified by:
        setSide in interface Axis
      • 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)
      • setTickLabelSpacing

        public void setTickLabelSpacing​(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 the tickUnitProperty().
        Specified by:
        setTickUnit in interface Axis
        Parameters:
        unit - major tick unit
      • setTimeAxis

        public void setTimeAxis​(boolean value)
        This is true when the axis labels and data point should be plotted according to some time-axis definition
        Specified by:
        setTimeAxis in interface Axis
        Parameters:
        value - true if axis shall be drawn with time-axis labels
      • setUnit

        public void setUnit​(java.lang.String value)
        Specified by:
        setUnit in interface Axis
        Parameters:
        value - the new axis primary unit name
      • setUnitScaling

        public void setUnitScaling​(double value)
        Specified by:
        setUnitScaling in interface Axis
        Parameters:
        value - the new axis primary unit label
      • setUnitScaling

        public void setUnitScaling​(MetricPrefix prefix)
        Specified by:
        setUnitScaling in interface Axis
        Parameters:
        prefix - the new axis primary unit label
      • sideProperty

        public javafx.beans.property.ObjectProperty<Side> sideProperty()
        Specified by:
        sideProperty in interface Axis
      • 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()
      • tickLabelSpacing

        public javafx.beans.property.DoubleProperty tickLabelSpacing()
      • 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:
        tickUnitProperty in interface Axis
        Returns:
        tickUnit property
      • timeAxisProperty

        public javafx.beans.property.BooleanProperty timeAxisProperty()
        This is true when the axis labels and data point should be plotted according to some time-axis definition
        Specified by:
        timeAxisProperty in interface Axis
        Returns:
        time axis property reference
      • unitProperty

        public javafx.beans.property.ObjectProperty<java.lang.String> unitProperty()
        Specified by:
        unitProperty in interface Axis
        Returns:
        the primary unit name property
      • unitScalingProperty

        public javafx.beans.property.DoubleProperty unitScalingProperty()
        Specified by:
        unitScalingProperty in interface Axis
        Returns:
        the primary unit label property
      • updateEventListener

        public java.util.List<de.gsi.dataset.event.EventListener> updateEventListener()
        Specified by:
        updateEventListener in interface de.gsi.dataset.event.EventSource
      • setScale

        protected void setScale​(double scale)
      • updateAxisLabelAndUnit

        protected void updateAxisLabelAndUnit()
      • updateScaleAndUnitPrefix

        protected void updateScaleAndUnitPrefix()
      • validProperty

        protected javafx.beans.property.BooleanProperty validProperty()
        valid flag property. This will cause anything that depends on the axis range or physical size to be recalculated on the next layout iteration.
        Returns:
        the validProperty()
      • 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.
      • equalString

        protected static boolean equalString​(java.lang.String str1,
                                             java.lang.String str2)