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

Modifier and Type	Class and Description
private static class	CategoryAxis.StyleableProperties

Modifier and Type	Field and Description
private List<String>	allDataCategories
private final ChartLayoutAnimator	animator
private ObjectProperty<ObservableList<String>>	categories
private final ReadOnlyDoubleWrapper	categorySpacing This is the gap between one category and the next along this axis
private boolean	changeIsLocal
private Object	currentAnimationID
private DoubleProperty	endMargin The margin between the last tick mark and the axis end
private final DoubleProperty	firstCategoryPos This is the position of the first category along this axis
private BooleanProperty	gapStartAndEnd If this is true then half the space between ticks is left at the start and end
private ListChangeListener<String>	itemsListener
private DoubleProperty	startMargin The margin between the axis start and the first tick-mark

Access	Constructor and Description
public	CategoryAxis() Create a auto-ranging category axis with an empty list of categories.
public	CategoryAxis(ObservableList<String> List of the categories for this axis categories) Create a category axis with the given categories.

Method Summary

Modifier and Type	Method and Description
protected Object	Returns: Range information, this is implementation dependent autoRange(double The length of the axis in screen coordinates length) Implements abstract javafx.scene.chart.Axis.autoRange. This calculates the categories based on the data provided to invalidateRange() method.
private double	calculateNewFirstPos(double length, double catSpacing)
private double	calculateNewSpacing(double length, List<String> categories)
private double	calculateRequiredSize(boolean axisVertical, double tickLabelRotation)
protected List<String>	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) Implements abstract javafx.scene.chart.Axis.calculateTickValues. Calculate a list of all the data values for each tick mark in range
public final ReadOnlyDoubleProperty	categorySpacingProperty()
private void	checkAndRemoveDuplicates(String category)
public final DoubleProperty	endMarginProperty()
public final BooleanProperty	gapStartAndEndProperty()
pack-priv final List<String>	getAllDataCategories()
public final ObservableList<String>	Returns: ObservableList of categories for this axis. getCategories() Returns a `ObservableList` of categories plotted on this axis.
public final double	getCategorySpacing()
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.chart.Axis.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.chart.Axis.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 double	Returns: display position or Double.NaN if value not one of the categories getDisplayPosition(String The data value to work out display position for value) Implements abstract javafx.scene.chart.Axis.getDisplayPosition. Get the display position along this axis for a given value.
private String	getDuplicate()
public final double	getEndMargin()
protected Object	Returns: A range object that can be passed to setRange() and calculateTickValues() getRange() Implements abstract javafx.scene.chart.Axis.getRange. Called to get the current axis range.
public final double	getStartMargin()
protected String	Returns: A formatted string for the given value getTickMarkLabel(String The value to format into a tick label string value) Implements abstract javafx.scene.chart.Axis.getTickMarkLabel. Get the string label name for a tick mark with the given value
public String	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) Implements abstract javafx.scene.chart.Axis.getValueForDisplay. Get the data value for the given display position on this axis.
public double	Returns: always Double.NaN for CategoryAxis getZeroPosition() Implements abstract javafx.scene.chart.Axis.getZeroPosition. Get the display position of the zero line along this axis.
public void	invalidateRange(List<String> The current set of all data that needs to be plotted on this axis data) Overrides javafx.scene.chart.Axis.invalidateRange. Called when data has changed and the range may not be valid any more.
public final boolean	isGapStartAndEnd()
public boolean	Returns: true if the given value is plottable on this axis isValueOnAxis(String The value to check if its on axis value) Implements abstract javafx.scene.chart.Axis.isValueOnAxis. Checks if the given value is plottable on this axis
protected Dimension2D	Returns: size of tick mark label for given value measureTickMarkSize(String tick mark value value, Object range to use during calculations range) Overrides javafx.scene.chart.Axis.measureTickMarkSize. Measure the size of the label for given tick mark value.
public final void	setCategories(ObservableList<String> the ordered list of categories plotted on this axis value) The ordered list of categories plotted on this axis.
public final void	setEndMargin(double value)
public final void	setGapStartAndEnd(boolean value)
protected void	setRange(Object A range object returned from autoRange() range, boolean If true animate the change in range animate) Implements abstract javafx.scene.chart.Axis.setRange. Called to set the current axis range to the given range.
public final void	setStartMargin(double value)
public final DoubleProperty	startMarginProperty()
public double	Returns: Numeric value for the given data value toNumericValue(String The data value to convert value) Implements abstract javafx.scene.chart.Axis.toNumericValue. All axis values must be representable by some numeric value.
public String	Returns: Data value for given numeric value toRealValue(double The numeric value to convert value) Implements abstract javafx.scene.chart.Axis.toRealValue. All axis values must be representable by some numeric value.

Inherited from javafx.scene.chart.Axis:: animatedProperty autoRangingProperty computePrefHeight computePrefWidth getAnimated getEffectiveSide getEffectiveTickLabelRotation getLabel getSide getTickLabelFill getTickLabelFont getTickLabelGap getTickLabelRotation getTickLength getTickMarks invalidateRange isAutoRanging isRangeValid isTickLabelsVisible isTickMarkVisible labelProperty layoutChildren measureTickMarkLabelSize measureTickMarkSize requestAxisLayout requestLayout setAnimated setAutoRanging setEffectiveOrientation setEffectiveTickLabelRotation setLabel setSide setTickLabelFill setTickLabelFont setTickLabelGap setTickLabelRotation setTickLabelsVisible setTickLength setTickMarkVisible shouldAnimate sideProperty tickLabelFillProperty tickLabelFontProperty tickLabelGapProperty tickLabelRotationProperty tickLabelsVisibleProperty tickLengthProperty tickMarksUpdated tickMarkVisibleProperty

allDataCategories	back to summary
private List<String> allDataCategories

animator	back to summary
private final ChartLayoutAnimator animator

categories	back to summary
private ObjectProperty<ObservableList<String>> categories

categorySpacing	back to summary
private final ReadOnlyDoubleWrapper categorySpacing This is the gap between one category and the next along this axis

changeIsLocal	back to summary
private boolean changeIsLocal

currentAnimationID	back to summary
private Object currentAnimationID

endMargin	back to summary
private DoubleProperty endMargin The margin between the last tick mark and the axis end

firstCategoryPos	back to summary
private final DoubleProperty firstCategoryPos This is the position of the first category along this axis

gapStartAndEnd	back to summary
private BooleanProperty gapStartAndEnd If this is true then half the space between ticks is left at the start and end

itemsListener	back to summary
private ListChangeListener<String> itemsListener

startMargin	back to summary
private DoubleProperty startMargin The margin between the axis start and the first tick-mark

CategoryAxis	back to summary
public CategoryAxis() Create a auto-ranging category axis with an empty list of categories.

CategoryAxis	back to summary
public CategoryAxis(ObservableList<String> categories) Create a category axis with the given categories. This will not auto-range but be fixed with the given categories. Parameters categories:ObservableList<String> List of the categories for this axis

Method Detail

autoRange	back to summary
protected Object autoRange(double length) Implements abstract javafx.scene.chart.Axis.autoRange. This calculates the categories based on the data provided to invalidateRange() method. This must not effect the state of the axis, changing any properties of the axis. Any results of the auto-ranging should be returned in the range object. This will we passed to setRange() if it has been decided to adopt this range for this axis. Parameters length:double The length of the axis in screen coordinates Returns:Object Range information, this is implementation dependent Annotations @Override

autoRange

back to summary

protected Object autoRange(double length)

Implements abstract javafx.scene.chart.Axis.autoRange.

This calculates the categories based on the data provided to invalidateRange() method. This must not effect the state of the axis, changing any properties of the axis. Any results of the auto-ranging should be returned in the range object. This will we passed to setRange() if it has been decided to adopt this range for this axis.

Parameters

length:double: The length of the axis in screen coordinates

Returns:Object

Range information, this is implementation dependent

Annotations

@Override

calculateNewFirstPos	back to summary
private double calculateNewFirstPos(double length, double catSpacing)

calculateNewSpacing	back to summary
private double calculateNewSpacing(double length, List<String> categories)

calculateRequiredSize	back to summary
private double calculateRequiredSize(boolean axisVertical, double tickLabelRotation)

calculateTickValues	back to summary
protected List<String> calculateTickValues(double length, Object range) Implements abstract javafx.scene.chart.Axis.calculateTickValues. Calculate a list of all the data values for each tick mark in range Parameters length:double The length of the axis in display units range:Object Doc from javafx.scene.chart.Axis.calculateTickValues. A range object returned from autoRange() Returns:List<String> A list of tick marks that fit along the axis if it was the given length Annotations @Override

calculateTickValues

back to summary

protected List<String> calculateTickValues(double length, Object range)

Implements abstract javafx.scene.chart.Axis.calculateTickValues.

Calculate a list of all the data values for each tick mark in range

Parameters

length:double

The length of the axis in display units

range:Object

Doc from javafx.scene.chart.Axis.calculateTickValues.

A range object returned from autoRange()

Returns:List<String>

A list of tick marks that fit along the axis if it was the given length

Annotations

@Override

categorySpacingProperty	back to summary
public final ReadOnlyDoubleProperty categorySpacingProperty()

checkAndRemoveDuplicates	back to summary
private void checkAndRemoveDuplicates(String category)

endMarginProperty	back to summary
public final DoubleProperty endMarginProperty()

gapStartAndEndProperty	back to summary
public final BooleanProperty gapStartAndEndProperty()

getAllDataCategories	back to summary
pack-priv final List<String> getAllDataCategories()

getCategories back to summary

getCategories	back to summary
public final ObservableList<String> getCategories() Returns a `ObservableList` of categories plotted on this axis. Returns:ObservableList<String> ObservableList of categories for this axis.

public final ObservableList<String> getCategories()

Returns a ObservableList of categories plotted on this axis.

Returns:ObservableList<String>: ObservableList of categories for this axis.

getCategorySpacing	back to summary
public final double getCategorySpacing()

getClassCssMetaData back to summary

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

Hides javafx.scene.chart.Axis.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData
Since: JavaFX 8.0

getCssMetaData back to summary

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

Overrides javafx.scene.chart.Axis.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.chart.Axis.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Returns:List<CssMetaData<? extends Styleable, ?>>

Doc from javafx.scene.Node.getCssMetaData.

The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.

Annotations

@Override

Since

JavaFX 8.0

getDisplayPosition	back to summary
public double getDisplayPosition(String value) Implements abstract javafx.scene.chart.Axis.getDisplayPosition. Get the display position along this axis for a given value. If the value is not equal to any of the categories, Double.NaN is returned Parameters value:String The data value to work out display position for Returns:double display position or Double.NaN if value not one of the categories Annotations @Override

getDisplayPosition

back to summary

public double getDisplayPosition(String value)

Implements abstract javafx.scene.chart.Axis.getDisplayPosition.

Get the display position along this axis for a given value. If the value is not equal to any of the categories, Double.NaN is returned

Parameters

value:String: The data value to work out display position for

Returns:double

display position or Double.NaN if value not one of the categories

Annotations

@Override

getDuplicate	back to summary
private String getDuplicate()

getEndMargin	back to summary
public final double getEndMargin()

getRange	back to summary
protected Object getRange() Implements abstract javafx.scene.chart.Axis.getRange. Called to get the current axis range. Returns:Object A range object that can be passed to setRange() and calculateTickValues() Annotations @Override

getRange

back to summary

protected Object getRange()

Implements abstract javafx.scene.chart.Axis.getRange.

Called to get the current axis range.

Returns:Object

A range object that can be passed to setRange() and calculateTickValues()

Annotations

@Override

getStartMargin	back to summary
public final double getStartMargin()

getTickMarkLabel	back to summary
protected String getTickMarkLabel(String value) Implements abstract javafx.scene.chart.Axis.getTickMarkLabel. Get the string label name for a tick mark with the given value Parameters value:String The value to format into a tick label string Returns:String A formatted string for the given value Annotations @Override

getTickMarkLabel

back to summary

protected String getTickMarkLabel(String value)

Implements abstract javafx.scene.chart.Axis.getTickMarkLabel.

Get the string label name for a tick mark with the given value

Parameters

value:String: The value to format into a tick label string

Returns:String

A formatted string for the given value

Annotations

@Override

getValueForDisplay	back to summary
public String getValueForDisplay(double displayPosition) Implements abstract javafx.scene.chart.Axis.getValueForDisplay. Get the data value for the given display position on this axis. If the axis is a CategoryAxis this will be the nearest value. Parameters displayPosition:double A pixel position on this axis Returns:String the nearest data value to the given pixel position or null if not on axis; Annotations @Override

getValueForDisplay

back to summary

public String getValueForDisplay(double displayPosition)

Implements abstract javafx.scene.chart.Axis.getValueForDisplay.

Get the data value for the given display position on this axis. If the axis is a CategoryAxis this will be the nearest value.

Parameters

displayPosition:double: A pixel position on this axis

Returns:String

the nearest data value to the given pixel position or null if not on axis;

Annotations

@Override

getZeroPosition	back to summary
public double getZeroPosition() Implements abstract javafx.scene.chart.Axis.getZeroPosition. Get the display position of the zero line along this axis. As there is no concept of zero on a CategoryAxis this is always Double.NaN. Returns:double always Double.NaN for CategoryAxis Annotations @Override

getZeroPosition

back to summary

public double getZeroPosition()

Implements abstract javafx.scene.chart.Axis.getZeroPosition.

Get the display position of the zero line along this axis. As there is no concept of zero on a CategoryAxis this is always Double.NaN.

Returns:double

always Double.NaN for CategoryAxis

Annotations

@Override

invalidateRange	back to summary
public void invalidateRange(List<String> data) Overrides javafx.scene.chart.Axis.invalidateRange. Called when data has changed and the range may not be valid any more. This is only called by the chart if isAutoRanging() returns true. If we are auto ranging it will cause layout to be requested and auto ranging to happen on next layout pass. Parameters data:List<String> The current set of all data that needs to be plotted on this axis Annotations @Override

invalidateRange

back to summary

public void invalidateRange(List<String> data)

Overrides javafx.scene.chart.Axis.invalidateRange.

Called when data has changed and the range may not be valid any more. This is only called by the chart if isAutoRanging() returns true. If we are auto ranging it will cause layout to be requested and auto ranging to happen on next layout pass.

Parameters

data:List<String>: The current set of all data that needs to be plotted on this axis

Annotations

@Override

isGapStartAndEnd	back to summary
public final boolean isGapStartAndEnd()

isValueOnAxis	back to summary
public boolean isValueOnAxis(String value) Implements abstract javafx.scene.chart.Axis.isValueOnAxis. Checks if the given value is plottable on this axis Parameters value:String The value to check if its on axis Returns:boolean true if the given value is plottable on this axis Annotations @Override

isValueOnAxis

back to summary

public boolean isValueOnAxis(String value)

Implements abstract javafx.scene.chart.Axis.isValueOnAxis.

Checks if the given value is plottable on this axis

Parameters

value:String: The value to check if its on axis

Returns:boolean

true if the given value is plottable on this axis

Annotations

@Override

measureTickMarkSize	back to summary
protected Dimension2D measureTickMarkSize(String value, Object range) Overrides javafx.scene.chart.Axis.measureTickMarkSize. Measure the size of the label for given tick mark value. This uses the font that is set for the tick marks Parameters value:String tick mark value range:Object range to use during calculations Returns:Dimension2D size of tick mark label for given value Annotations @Override

measureTickMarkSize

back to summary

protected Dimension2D measureTickMarkSize(String value, Object range)

Overrides javafx.scene.chart.Axis.measureTickMarkSize.

Measure the size of the label for given tick mark value. This uses the font that is set for the tick marks

Parameters

value:String: tick mark value
range:Object: range to use during calculations

Returns:Dimension2D

size of tick mark label for given value

Annotations

@Override

setCategories back to summary

setCategories	back to summary
public final void setCategories(ObservableList<String> value) The ordered list of categories plotted on this axis. This is set automatically based on the charts data if autoRanging is true. If the application sets the categories then auto ranging is turned off. If there is an attempt to add duplicate entry into this list, an `IllegalArgumentException` is thrown. Parameters value:ObservableList<String> the ordered list of categories plotted on this axis

public final void setCategories(ObservableList<String> value)

The ordered list of categories plotted on this axis. This is set automatically based on the charts data if autoRanging is true. If the application sets the categories then auto ranging is turned off. If there is an attempt to add duplicate entry into this list, an IllegalArgumentException is thrown.

Parameters

value:ObservableList<String>: the ordered list of categories plotted on this axis

setEndMargin	back to summary
public final void setEndMargin(double value)

setGapStartAndEnd	back to summary
public final void setGapStartAndEnd(boolean value)

setRange	back to summary
protected void setRange(Object range, boolean animate) Implements abstract javafx.scene.chart.Axis.setRange. Called to set the current axis range to the given range. If isAnimating() is true then this method should animate the range to the new range. Parameters range:Object A range object returned from autoRange() animate:boolean If true animate the change in range Annotations @Override

setRange

back to summary

protected void setRange(Object range, boolean animate)

Implements abstract javafx.scene.chart.Axis.setRange.

Called to set the current axis range to the given range. If isAnimating() is true then this method should animate the range to the new range.

Parameters

range:Object: A range object returned from autoRange()
animate:boolean: If true animate the change in range

Annotations

@Override

setStartMargin	back to summary
public final void setStartMargin(double value)

startMarginProperty	back to summary
public final DoubleProperty startMarginProperty()

toNumericValue	back to summary
public double toNumericValue(String value) Implements abstract javafx.scene.chart.Axis.toNumericValue. All axis values must be representable by some numeric value. This gets the numeric value for a given data value. Parameters value:String The data value to convert Returns:double Numeric value for the given data value Annotations @Override

toNumericValue

back to summary

public double toNumericValue(String value)

Implements abstract javafx.scene.chart.Axis.toNumericValue.

All axis values must be representable by some numeric value. This gets the numeric value for a given data value.

Parameters

value:String: The data value to convert

Returns:double

Numeric value for the given data value

Annotations

@Override

toRealValue

back to summary

public String toRealValue(double value)

Implements abstract javafx.scene.chart.Axis.toRealValue.

All axis values must be representable by some numeric value. This gets the data value for a given numeric value.

Parameters

value:double: The numeric value to convert

Returns:String

Data value for given numeric value

Annotations

@Override

Modifier and Type	Field and Description
private static final CssMetaData<CategoryAxis, Number>	END_MARGIN
private static final CssMetaData<CategoryAxis, Boolean>	GAP_START_AND_END
private static final CssMetaData<CategoryAxis, Number>	START_MARGIN
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

public final Class CategoryAxis

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CategoryAxis.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail