javafx.scene.chart

Class Chart

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.chart.Chart

All Implemented Interfaces:

Styleable, EventTarget

Direct Known Subclasses:

PieChart, XYChart

public abstract class Chart
extends Region

Base class for all charts. It has 3 parts the title, legend and chartContent. The chart content is populated by the specific subclass of Chart.

Since:

JavaFX 2.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private BooleanProperty	animated When true any data changes will be animated.
private ChartLayoutAnimator	animator Animator for animating stuff on the chart
private Pane	chartContent This is the Pane that Chart subclasses use to contain the chart content, It is sized to be inside the chart area leaving space for the title and legend.
private ObjectProperty<Node>	legend The node to display as the Legend.
private ObjectProperty<Side>	legendSide The side of the chart where the legend should be displayed
private BooleanProperty	legendVisible When true the chart will display a legend if the chart implementation supports a legend.
private static int	MIN_HEIGHT_TO_LEAVE_FOR_CHART_CONTENT
private static int	MIN_WIDTH_TO_LEAVE_FOR_CHART_CONTENT
private StringProperty	title The chart title
private Label	titleLabel Title Label
private ObjectProperty<Side>	titleSide The side of the chart where the title is displayed
(package private) boolean	useChartContentMirroring

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 and Description
Chart() Creates a new default Chart instance.

Method Summary

Modifier and Type	Method and Description
protected void	animate(Animation animation) Play the given animation on every frame of the animation the chart will be relayed out until the animation finishes.
(package private) void	animate(KeyFrame... keyFrames) Play a animation involving the given keyframes.
BooleanProperty	animatedProperty()
protected double	computeMinHeight(double width) Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
protected double	computeMinWidth(double height) Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
protected double	computePrefHeight(double width) Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
protected double	computePrefWidth(double height) Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
boolean	getAnimated() Indicates whether data changes will be animated or not.
protected ObservableList<Node>	getChartChildren() Modifiable and observable list of all content in the chart.
static java.util.List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
java.util.List<CssMetaData<? extends Styleable,?>>	getCssMetaData() This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.
protected Node	getLegend()
Side	getLegendSide()
java.lang.String	getTitle()
Side	getTitleSide()
boolean	isLegendVisible()
protected abstract void	layoutChartChildren(double top, double left, double width, double height) Called to update and layout the chart children available from getChartChildren()
protected void	layoutChildren() Invoked during the layout pass to layout this chart and all its content.
protected ObjectProperty<Node>	legendProperty()
ObjectProperty<Side>	legendSideProperty()
BooleanProperty	legendVisibleProperty()
protected void	requestChartLayout() Call this when you know something has changed that needs the chart to be relayed out.
void	setAnimated(boolean value)
protected void	setLegend(Node value)
void	setLegendSide(Side value)
void	setLegendVisible(boolean value)
void	setTitle(java.lang.String value)
void	setTitleSide(Side value)
protected boolean	shouldAnimate() This is used to check if any given animation should run.
StringProperty	titleProperty()
ObjectProperty<Side>	titleSideProperty()

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, 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, containsBounds, 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, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Field Detail

MIN_WIDTH_TO_LEAVE_FOR_CHART_CONTENT

private static final int MIN_WIDTH_TO_LEAVE_FOR_CHART_CONTENT

See Also:

Constant Field Values

MIN_HEIGHT_TO_LEAVE_FOR_CHART_CONTENT

private static final int MIN_HEIGHT_TO_LEAVE_FOR_CHART_CONTENT

See Also:

Constant Field Values

titleLabel

private final Label titleLabel

Title Label

chartContent

private final Pane chartContent

This is the Pane that Chart subclasses use to contain the chart content, It is sized to be inside the chart area leaving space for the title and legend.

useChartContentMirroring

boolean useChartContentMirroring

animator

private final ChartLayoutAnimator animator

Animator for animating stuff on the chart

title

private StringProperty title

The chart title

titleSide

private ObjectProperty<Side> titleSide

The side of the chart where the title is displayed

legend

private final ObjectProperty<Node> legend

The node to display as the Legend. Subclasses can set a node here to be displayed on a side as the legend. If no legend is wanted then this can be set to null

legendVisible

private final BooleanProperty legendVisible

When true the chart will display a legend if the chart implementation supports a legend.

legendSide

private ObjectProperty<Side> legendSide

The side of the chart where the legend should be displayed

animated

private BooleanProperty animated

When true any data changes will be animated.

Constructor Detail

Chart

public Chart()

Creates a new default Chart instance.

Method Detail

getTitle

public final java.lang.String getTitle()

setTitle

public final void setTitle(java.lang.String value)

titleProperty

public final StringProperty titleProperty()

getTitleSide

public final Side getTitleSide()

setTitleSide

public final void setTitleSide(Side value)

titleSideProperty

public final ObjectProperty<Side> titleSideProperty()

getLegend

protected final Node getLegend()

setLegend

protected final void setLegend(Node value)

legendProperty

protected final ObjectProperty<Node> legendProperty()

isLegendVisible

public final boolean isLegendVisible()

setLegendVisible

public final void setLegendVisible(boolean value)

legendVisibleProperty

public final BooleanProperty legendVisibleProperty()

getLegendSide

public final Side getLegendSide()

setLegendSide

public final void setLegendSide(Side value)

legendSideProperty

public final ObjectProperty<Side> legendSideProperty()

getAnimated

public final boolean getAnimated()

Indicates whether data changes will be animated or not.

Returns:

true if data changes will be animated and false otherwise.

setAnimated

public final void setAnimated(boolean value)

animatedProperty

public final BooleanProperty animatedProperty()

getChartChildren

protected ObservableList<Node> getChartChildren()

Modifiable and observable list of all content in the chart. This is where implementations of Chart should add any nodes they use to draw their chart. This excludes the legend and title which are looked after by this class.

Returns:

Observable list of plot children

animate

void animate(KeyFrame... keyFrames)

Play a animation involving the given keyframes. On every frame of the animation the chart will be relayed out

Parameters:

keyFrames - Array of KeyFrames to play

animate

protected void animate(Animation animation)

Play the given animation on every frame of the animation the chart will be relayed out until the animation finishes. So to add a animation to a chart, create a animation on data model, during layoutChartContent() map data model to nodes then call this method with the animation.

Parameters:

animation - The animation to play

requestChartLayout

protected void requestChartLayout()

Call this when you know something has changed that needs the chart to be relayed out.

shouldAnimate

protected final boolean shouldAnimate()

This is used to check if any given animation should run. It returns true if animation is enabled and the node is visible and in a scene.

layoutChartChildren

protected abstract void layoutChartChildren(double top,
                                            double left,
                                            double width,
                                            double height)

Called to update and layout the chart children available from getChartChildren()

Parameters:

top - The top offset from the origin to account for any padding on the chart content

left - The left offset from the origin to account for any padding on the chart content

width - The width of the area to layout the chart within

height - The height of the area to layout the chart within

layoutChildren

protected void layoutChildren()

Invoked during the layout pass to layout this chart and all its content.

Overrides:

layoutChildren in class Parent

computeMinHeight

protected double computeMinHeight(double width)

Charts are sized outside in, user tells chart how much space it has and chart draws inside that. So minimum height is a constant 150.

Overrides:

computeMinHeight in class Region

Parameters:

width - the width that should be used if min height depends on it

Returns:

the computed minimum height for this region

computeMinWidth

protected double computeMinWidth(double height)

Charts are sized outside in, user tells chart how much space it has and chart draws inside that. So minimum width is a constant 200.

Overrides:

computeMinWidth in class Region

Parameters:

height - the height that should be used if min width depends on it

Returns:

the computed minimum width of this region

computePrefWidth

protected double computePrefWidth(double height)

Charts are sized outside in, user tells chart how much space it has and chart draws inside that. So preferred width is a constant 500.

Overrides:

computePrefWidth in class Region

Parameters:

height - the height that should be used if preferred width depends on it

Returns:

the computed preferred width for this region

computePrefHeight

protected double computePrefHeight(double width)

Charts are sized outside in, user tells chart how much space it has and chart draws inside that. So preferred height is a constant 400.

Overrides:

computePrefHeight in class Region

Parameters:

width - the width that should be used if preferred height depends on it

Returns:

the computed preferred height for this region

getClassCssMetaData

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

Returns:

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

Since:

JavaFX 8.0

getCssMetaData

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

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

Specified by:

getCssMetaData in interface Styleable

Overrides:

getCssMetaData in class Region

Returns:

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

Since:

JavaFX 8.0