javafx.scene.chart

Class CategoryAxis

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

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

javafx.scene.chart.CategoryAxis

All Implemented Interfaces:

EventTarget

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.

Property Summary

Properties

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

animated, autoRanging, label, side, tickLabelFill, tickLabelFont, tickLabelGap, tickLabelRotation, tickLabelsVisible, tickLength, tickMarkVisible

Properties inherited from class javafx.scene.layout.Region

height, maxHeight, maxWidth, minHeight, minWidth, padding, prefHeight, prefWidth, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Nested Class Summary

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

Axis.TickMark<T>

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
CategoryAxis() Create a auto-ranging category axis
CategoryAxis(ObservableList<java.lang.String> categories) Create a category axis with the given categories.

Method Summary

Methods

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.
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
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
ObservableList<java.lang.String>	getCategories() Returns a ObservableList of categories plotted on this axis.
double	getCategorySpacing() Gets the value of the property categorySpacing.
double	getDisplayPosition(java.lang.String value) Get the display position along this axis for a given value
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(ObservableList<java.lang.String> value)
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, getLabel, getSide, getTickLabelFill, getTickLabelFont, getTickLabelGap, getTickLabelRotation, getTickLength, getTickMarks, invalidateRange, isAutoRanging, isRangeValid, isTickLabelsVisible, isTickMarkVisible, labelProperty, layoutChildren, measureTickMarkLabelSize, measureTickMarkSize, requestAxisLayout, requestLayout, setAnimated, setAutoRanging, setLabel, setSide, setTickLabelFill, setTickLabelFont, setTickLabelGap, setTickLabelRotation, setTickLabelsVisible, setTickLength, setTickMarkVisible, shouldAnimate, sideProperty, tickLabelFillProperty, tickLabelFontProperty, tickLabelGapProperty, tickLabelRotationProperty, tickLabelsVisibleProperty, tickLengthProperty, tickMarksUpdated, tickMarkVisibleProperty

Methods inherited from class javafx.scene.layout.Region

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPadding, getPrefHeight, getPrefWidth, getWidth, heightProperty, isResizable, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setSnapToPixel, setWidth, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, 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, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, 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, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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()

Constructor Detail

CategoryAxis

public CategoryAxis()

Create a auto-ranging category axis

CategoryAxis

public CategoryAxis(ObservableList<java.lang.String> 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.

Property description:

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

setStartMargin

public final void setStartMargin(double value)

Sets the value of the property startMargin.

Property description:

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

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.

Property description:

The margin between the last tick mark and the axis end

setEndMargin

public final void setEndMargin(double value)

Sets the value of the property endMargin.

Property description:

The margin between the last tick mark and the axis end

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.

Property description:

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

setGapStartAndEnd

public final void setGapStartAndEnd(boolean value)

Sets the value of the property gapStartAndEnd.

Property description:

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

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(ObservableList<java.lang.String> value)

getCategories

public final ObservableList<java.lang.String> getCategories()

Returns a ObservableList of categories plotted on this axis.

Returns:

ObservableList of categories for this axis.

See Also:

categories

getCategorySpacing

public final double getCategorySpacing()

Gets the value of the property categorySpacing.

Property description:

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

categorySpacingProperty

public final ReadOnlyDoubleProperty categorySpacingProperty()

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

See Also:

getCategorySpacing()

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

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

getDisplayPosition

public double getDisplayPosition(java.lang.String value)

Get the display position along this axis for a given value

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 zero is not in current range;

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