javafx.scene.chart

Class CategoryAxis

java.lang.Object

Region

javafx.scene.chart.Axis<java.lang.String>

javafx.scene.chart.CategoryAxis

public final class CategoryAxis
extends Axis<java.lang.String>

A axis implementation that will works on string categories where each value as a unique category(tick mark) along the axis.

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
ReadOnlyDoubleProperty	categorySpacing This is the gap between one category and the next along this axis
DoubleProperty	endMargin The margin between the last tick mark and the axis end
BooleanProperty	gapStartAndEnd If this is true then half the space between ticks is left at the start and end
DoubleProperty	startMargin The margin between the axis start and the first tick-mark

Properties inherited from class javafx.scene.chart.Axis

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class javafx.scene.chart.Axis

Axis.TickMark<T>

Field Summary

Fields

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

Fields inherited from class javafx.scene.chart.Axis

measure, measureInvalid, rangeValid, tickLabelsVisibleInvalid

Constructor Summary

Constructors

Constructor and Description
CategoryAxis() Create a auto-ranging category axis with an empty list of categories.
CategoryAxis(<any> categories) Create a category axis with the given categories.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	autoRange(double length) This calculates the categories based on the data provided to invalidateRange() method.
private double	calculateNewFirstPos(double length, double catSpacing)
private double	calculateNewSpacing(double length, java.util.List<java.lang.String> categories)
private double	calculateRequiredSize(boolean axisVertical, double tickLabelRotation)
protected java.util.List<java.lang.String>	calculateTickValues(double length, java.lang.Object range) Calculate a list of all the data values for each tick mark in range
ReadOnlyDoubleProperty	categorySpacingProperty() This is the gap between one category and the next along this axis
private void	checkAndRemoveDuplicates(java.lang.String category)
DoubleProperty	endMarginProperty() The margin between the last tick mark and the axis end
BooleanProperty	gapStartAndEndProperty() If this is true then half the space between ticks is left at the start and end
(package private) java.util.List<java.lang.String>	getAllDataCategories()
<any>	getCategories() Returns a ObservableList of categories plotted on this axis.
double	getCategorySpacing() Gets the value of the property categorySpacing.
static java.util.List<<any>>	getClassCssMetaData()
java.util.List<<any>>	getCssMetaData()
double	getDisplayPosition(java.lang.String value) Get the display position along this axis for a given value.
private java.lang.String	getDuplicate()
double	getEndMargin() Gets the value of the property endMargin.
protected java.lang.Object	getRange() Called to get the current axis range.
double	getStartMargin() Gets the value of the property startMargin.
protected java.lang.String	getTickMarkLabel(java.lang.String value) Get the string label name for a tick mark with the given value
java.lang.String	getValueForDisplay(double displayPosition) Get the data value for the given display position on this axis.
double	getZeroPosition() Get the display position of the zero line along this axis.
void	invalidateRange(java.util.List<java.lang.String> data) Called when data has changed and the range may not be valid any more.
boolean	isGapStartAndEnd() Gets the value of the property gapStartAndEnd.
boolean	isValueOnAxis(java.lang.String value) Checks if the given value is plottable on this axis
protected Dimension2D	measureTickMarkSize(java.lang.String value, java.lang.Object range) Measure the size of the label for given tick mark value.
void	setCategories(<any> value) The ordered list of categories plotted on this axis.
void	setEndMargin(double value) Sets the value of the property endMargin.
void	setGapStartAndEnd(boolean value) Sets the value of the property gapStartAndEnd.
protected void	setRange(java.lang.Object range, boolean animate) Called to set the current axis range to the given range.
void	setStartMargin(double value) Sets the value of the property startMargin.
DoubleProperty	startMarginProperty() The margin between the axis start and the first tick-mark
double	toNumericValue(java.lang.String value) All axis values must be representable by some numeric value.
java.lang.String	toRealValue(double value) All axis values must be representable by some numeric value.

Methods inherited from class 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

startMargin

public final DoubleProperty startMarginProperty

The margin between the axis start and the first tick-mark

See Also:

getStartMargin(), setStartMargin(double)

endMargin

public final DoubleProperty endMarginProperty

The margin between the last tick mark and the axis end

See Also:

getEndMargin(), setEndMargin(double)

gapStartAndEnd

public final BooleanProperty gapStartAndEndProperty

If this is true then half the space between ticks is left at the start and end

See Also:

isGapStartAndEnd(), setGapStartAndEnd(boolean)

categorySpacing

public final ReadOnlyDoubleProperty categorySpacingProperty

This is the gap between one category and the next along this axis

See Also:

getCategorySpacing()

Field Detail

allDataCategories

private java.util.List<java.lang.String> allDataCategories

changeIsLocal

private boolean changeIsLocal

firstCategoryPos

private final DoubleProperty firstCategoryPos

This is the gap between one category and the next along this axis

currentAnimationID

private java.lang.Object currentAnimationID

animator

private final ChartLayoutAnimator animator

itemsListener

private <any> itemsListener

startMargin

private DoubleProperty startMargin

The margin between the axis start and the first tick-mark

endMargin

private DoubleProperty endMargin

The margin between the last tick mark and the axis end

gapStartAndEnd

private BooleanProperty gapStartAndEnd

If this is true then half the space between ticks is left at the start and end

categories

private <any> categories

categorySpacing

private final ReadOnlyDoubleWrapper categorySpacing

This is the gap between one category and the next along this axis

Constructor Detail

CategoryAxis

public CategoryAxis()

Create a auto-ranging category axis with an empty list of categories.

CategoryAxis

public CategoryAxis(<any> categories)

Create a category axis with the given categories. This will not auto-range but be fixed with the given categories.

Parameters:

categories - List of the categories for this axis

Method Detail

getStartMargin

public final double getStartMargin()

Gets the value of the property startMargin.

setStartMargin

public final void setStartMargin(double value)

Sets the value of the property startMargin.

startMarginProperty

public final DoubleProperty startMarginProperty()

The margin between the axis start and the first tick-mark

See Also:

getStartMargin(), setStartMargin(double)

getEndMargin

public final double getEndMargin()

Gets the value of the property endMargin.

setEndMargin

public final void setEndMargin(double value)

Sets the value of the property endMargin.

endMarginProperty

public final DoubleProperty endMarginProperty()

The margin between the last tick mark and the axis end

See Also:

getEndMargin(), setEndMargin(double)

isGapStartAndEnd

public final boolean isGapStartAndEnd()

Gets the value of the property gapStartAndEnd.

setGapStartAndEnd

public final void setGapStartAndEnd(boolean value)

Sets the value of the property gapStartAndEnd.

gapStartAndEndProperty

public final BooleanProperty gapStartAndEndProperty()

If this is true then half the space between ticks is left at the start and end

See Also:

isGapStartAndEnd(), setGapStartAndEnd(boolean)

setCategories

public final void setCategories(<any> 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 - the ordered list of categories plotted on this axis

checkAndRemoveDuplicates

private void checkAndRemoveDuplicates(java.lang.String category)

getDuplicate

private java.lang.String getDuplicate()

getCategories

public final <any> getCategories()

Returns a ObservableList of categories plotted on this axis.

Returns:

ObservableList of categories for this axis.

getCategorySpacing

public final double getCategorySpacing()

Gets the value of the property categorySpacing.

categorySpacingProperty

public final ReadOnlyDoubleProperty categorySpacingProperty()

This is the gap between one category and the next along this axis

See Also:

getCategorySpacing()

calculateNewSpacing

private double calculateNewSpacing(double length,
                                   java.util.List<java.lang.String> categories)

calculateNewFirstPos

private double calculateNewFirstPos(double length,
                                    double catSpacing)

getRange

protected java.lang.Object getRange()

Called to get the current axis range.

Specified by:

getRange in class Axis<java.lang.String>

Returns:

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

setRange

protected void setRange(java.lang.Object range,
                        boolean animate)

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.

Specified by:

setRange in class Axis<java.lang.String>

Parameters:

range - A range object returned from autoRange()

animate - If true animate the change in range

autoRange

protected java.lang.Object autoRange(double length)

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.

Specified by:

autoRange in class Axis<java.lang.String>

Parameters:

length - The length of the axis in screen coordinates

Returns:

Range information, this is implementation dependent

calculateRequiredSize

private double calculateRequiredSize(boolean axisVertical,
                                     double tickLabelRotation)

calculateTickValues

protected java.util.List<java.lang.String> calculateTickValues(double length,
                                                               java.lang.Object range)

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

Specified by:

calculateTickValues in class Axis<java.lang.String>

Parameters:

length - The length of the axis in display units

range - A range object returned from autoRange()

Returns:

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

getTickMarkLabel

protected java.lang.String getTickMarkLabel(java.lang.String value)

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

Specified by:

getTickMarkLabel in class Axis<java.lang.String>

Parameters:

value - The value to format into a tick label string

Returns:

A formatted string for the given value

measureTickMarkSize

protected Dimension2D measureTickMarkSize(java.lang.String value,
                                          java.lang.Object range)

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

Overrides:

measureTickMarkSize in class Axis<java.lang.String>

Parameters:

value - tick mark value

range - range to use during calculations

Returns:

size of tick mark label for given value

invalidateRange

public void invalidateRange(java.util.List<java.lang.String> data)

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.

Overrides:

invalidateRange in class Axis<java.lang.String>

Parameters:

data - The current set of all data that needs to be plotted on this axis

getAllDataCategories

final java.util.List<java.lang.String> getAllDataCategories()

getDisplayPosition

public double getDisplayPosition(java.lang.String value)

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

Specified by:

getDisplayPosition in class Axis<java.lang.String>

Parameters:

value - The data value to work out display position for

Returns:

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

getValueForDisplay

public java.lang.String getValueForDisplay(double displayPosition)

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

Specified by:

getValueForDisplay in class Axis<java.lang.String>

Parameters:

displayPosition - A pixel position on this axis

Returns:

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

isValueOnAxis

public boolean isValueOnAxis(java.lang.String value)

Checks if the given value is plottable on this axis

Specified by:

isValueOnAxis in class Axis<java.lang.String>

Parameters:

value - The value to check if its on axis

Returns:

true if the given value is plottable on this axis

toNumericValue

public double toNumericValue(java.lang.String value)

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

Specified by:

toNumericValue in class Axis<java.lang.String>

Parameters:

value - The data value to convert

Returns:

Numeric value for the given data value

toRealValue

public java.lang.String toRealValue(double value)

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

Specified by:

toRealValue in class Axis<java.lang.String>

Parameters:

value - The numeric value to convert

Returns:

Data value for given numeric value

getZeroPosition

public double 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.

Specified by:

getZeroPosition in class Axis<java.lang.String>

Returns:

always Double.NaN for CategoryAxis

getClassCssMetaData

public static java.util.List<<any>> getClassCssMetaData()

Returns:

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

Since:

JavaFX 8.0

getCssMetaData

public java.util.List<<any>> getCssMetaData()

Overrides:

getCssMetaData in class Axis<java.lang.String>

Since:

JavaFX 8.0