JavaFX 24 · javafx.scene.chart.Axis · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	Axis.StyleableProperties
public static class	Axis.TickMark< the axis data type T> TickMark represents the label text, its associated properties for each tick along the Axis.

Field Summary

Modifier and Type	Field and Description
private BooleanProperty	animated When true any changes to the axis and its range will be animated.
private BooleanProperty	autoRanging This is true when the axis determines its range from the data automatically
private Label	axisLabel
private static final PseudoClass	BOTTOM_PSEUDOCLASS_STATE pseudo-class indicating this is a vertical Bottom side Axis.
private Orientation	effectiveOrientation
private double	effectiveTickLabelRotation
private ObjectProperty<String>	label The axis label
private BitSet	labelsToSkip
private static final PseudoClass	LEFT_PSEUDOCLASS_STATE pseudo-class indicating this is a vertical Left side Axis.
pack-priv Text	measure
pack-priv boolean	measureInvalid
private double	oldLength
pack-priv boolean	rangeValid True when the current range invalid and all dependent calculations need to be updated
private static final PseudoClass	RIGHT_PSEUDOCLASS_STATE pseudo-class indicating this is a vertical Right side Axis.
private ObjectProperty<Side>	side The side of the plot which this axis is being drawn on
private ObjectProperty<Paint>	tickLabelFill The fill for all tick labels
private ObjectProperty<Font>	tickLabelFont The font for all tick labels
private DoubleProperty	tickLabelGap The gap between tick labels and the tick mark lines
private DoubleProperty	tickLabelRotation Rotation in degrees of tick mark labels from their normal horizontal.
private BooleanProperty	tickLabelsVisible true if tick mark labels should be displayed
pack-priv boolean	tickLabelsVisibleInvalid
private DoubleProperty	tickLength The length of tick mark lines
private final Path	tickMarkPath
private final ObservableList<Axis.TickMark<T>>	tickMarks
private BooleanProperty	tickMarkVisible true if tick marks should be displayed
private static final PseudoClass	TOP_PSEUDOCLASS_STATE pseudo-class indicating this is a vertical Top side Axis.
private final ObservableList<Axis.TickMark<T>>	unmodifiableTickMarks

Inherited from javafx.scene.layout.Region:: USE_COMPUTED_SIZE USE_PREF_SIZE

Access	Constructor and Description
public	Axis() Creates and initializes a new instance of the Axis class.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	animatedProperty()
protected abstract Object	Returns: Range information, this is implementation dependent autoRange(double The length of the axis in screen coordinates length) This calculates the upper and lower bound based on the data provided to invalidateRange() method.
public final BooleanProperty	autoRangingProperty()
protected abstract List<T>	Returns: A list of tick marks that fit along the axis if it was the given length calculateTickValues(double The length of the axis in display units length, Object A range object returned from autoRange() range) Calculate a list of all the data values for each tick mark in range
protected double	Returns: the computed preferred width for this axis computePrefHeight(double the width that should be used if preferred height depends on it width) Overrides javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this axis for the given width.
protected double	Returns: the computed preferred width for this axis computePrefWidth(double the height that should be used if preferred width depends on it height) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this axis for the given height.
public final boolean	Returns: true if axis range changes will be animated and false otherwise getAnimated() Indicates whether the changes to axis range will be animated or not.
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.layout.Region.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.layout.Region.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public abstract double	Returns: display position or Double.NaN if value not valid getDisplayPosition(T The data value to work out display position for value) Get the display position along this axis for a given value.
pack-priv final Side	getEffectiveSide()
pack-priv final double	getEffectiveTickLabelRotation()
public final String	getLabel()
protected abstract Object	Returns: A range object that can be passed to setRange() and calculateTickValues() getRange() Called to get the current axis range.
public final Side	getSide()
public final Paint	getTickLabelFill()
public final Font	getTickLabelFont()
public final double	getTickLabelGap()
public final double	getTickLabelRotation()
public final double	getTickLength()
protected abstract String	Returns: A formatted string for the given value getTickMarkLabel(T The value to format into a tick label string value) Get the string label name for a tick mark with the given value
public ObservableList<Axis.TickMark<T>>	Returns: Unmodifiable observable list of TickMarks on this axis getTickMarks() Unmodifiable observable list of tickmarks, each TickMark directly representing a tickmark on this axis.
public abstract T	Returns: the nearest data value to the given pixel position or null if not on axis; getValueForDisplay(double A pixel position on this axis displayPosition) Get the data value for the given display position on this axis.
public abstract double	Returns: display position or Double.NaN if zero is not in current range; getZeroPosition() Get the display position of the zero line along this axis.
protected final void	invalidateRange() Mark the current range invalid, this will cause anything that depends on the range to be recalculated on the next layout.
public void	invalidateRange(List<T> The current set of all data that needs to be plotted on this axis data) Called when data has changed and the range may not be valid any more.
public final boolean	isAutoRanging()
protected final boolean	Returns: true if current range calculations are valid isRangeValid() See if the current range is valid, if it is not then any range dependent calculations need to redone on the next layout pass
private boolean	Returns: true if labels overlap isTickLabelsOverlap(Side side of the Axis side, Axis.TickMark<T> first tick mark m1, Axis.TickMark<T> second tick mark m2, double minimum space between labels gap) Checks if two consecutive tick mark labels overlaps.
public final boolean	isTickLabelsVisible()
public final boolean	isTickMarkVisible()
public abstract boolean	Returns: true if the given value is plottable on this axis isValueOnAxis(T The value to check if its on axis value) Checks if the given value is plottable on this axis
public final ObjectProperty<String>	labelProperty()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout this axis and all its content.
protected final Dimension2D	Returns: size of tick mark label for given value measureTickMarkLabelSize(String tick mark label text labelText, double The text rotation rotation) Measure the size of the label for given tick mark value.
protected final Dimension2D	Returns: size of tick mark label for given value measureTickMarkSize(T tick mark value value, double The text rotation rotation) Measure the size of the label for given tick mark value.
protected Dimension2D	Returns: size of tick mark label for given value measureTickMarkSize(T tick mark value value, Object range to use during calculations range) Measure the size of the label for given tick mark value.
private double	Returns: size of tick mark label for given value measureTickMarkSize(T tick mark value value, Side side of this Axis side) Measure the size of the label for given tick mark value.
private void	positionTextNode(Text The text node to position node, double The x position, to place text next to posX, double The y position, to place text next to posY, double The text rotation angle, Side The side to place text next to position x,y at side) Positions a text node to one side of the given point, it X height is vertically centered on point if LEFT or RIGHT and its centered horizontally if TOP ot BOTTOM.
public void	requestAxisLayout() Request that the axis is laid out in the next layout pass.
public void	requestLayout() Overrides javafx.scene.Parent.requestLayout. We suppress requestLayout() calls here by doing nothing as we don't want changes to our children to cause layout.
public final void	setAnimated(boolean value)
public final void	setAutoRanging(boolean value)
pack-priv final void	setEffectiveOrientation(Orientation orientation)
pack-priv final void	setEffectiveTickLabelRotation(double NaN for using the tickLabelRotationProperty() rotation)
public final void	setLabel(String value)
protected abstract void	setRange(Object A range object returned from autoRange() range, boolean If true animate the change in range animate) Called to set the current axis range to the given range.
public final void	setSide(Side value)
public final void	setTickLabelFill(Paint value)
public final void	setTickLabelFont(Font value)
public final void	setTickLabelGap(double value)
public final void	setTickLabelRotation(double value)
public final void	setTickLabelsVisible(boolean value)
public final void	setTickLength(double value)
public final void	setTickMarkVisible(boolean value)
protected final boolean	Returns: true if animations should happen shouldAnimate() This is used to check if any given animation should run.
public final ObjectProperty<Side>	sideProperty()
public final ObjectProperty<Paint>	tickLabelFillProperty()
public final ObjectProperty<Font>	tickLabelFontProperty()
public final DoubleProperty	tickLabelGapProperty()
public final DoubleProperty	tickLabelRotationProperty()
public final BooleanProperty	tickLabelsVisibleProperty()
public final DoubleProperty	tickLengthProperty()
protected void	tickMarksUpdated() Called during layout if the tickmarks have been updated, allowing subclasses to do anything they need to in reaction.
public final BooleanProperty	tickMarkVisibleProperty()
public abstract double	Returns: Numeric value for the given data value toNumericValue(T The data value to convert value) All axis values must be representable by some numeric value.
public abstract T	Returns: Data value for given numeric value toRealValue(double The numeric value to convert value) All axis values must be representable by some numeric value.
private void	updateTickMark(Axis.TickMark<T> tick, double length, double startX, double startY, double endX, double endY) Updates visibility of the text node and adds the tick mark to the path
private void	updateTickMarks(Side side, double length)

Inherited from 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 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

public abstract Class Axis<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary