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

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

Modifier and Type	Field and Description
private BooleanProperty	animated When true any data changes will be animated.
private final ChartLayoutAnimator	animator Animator for animating stuff on the chart
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.
private final 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 final BooleanProperty	legendVisible When true the chart will display a legend if the chart implementation supports a legend.
private static final int	MIN_HEIGHT_TO_LEAVE_FOR_CHART_CONTENT
private static final int	MIN_WIDTH_TO_LEAVE_FOR_CHART_CONTENT
private StringProperty	title The chart title
private final Label	titleLabel Title Label
private ObjectProperty<Side>	titleSide The side of the chart where the title is displayed
pack-priv boolean	useChartContentMirroring

Access	Constructor and Description
public	Chart() Creates a new default Chart instance.

Method Summary

Modifier and Type	Method and Description
pack-priv void	animate(KeyFrame... Array of KeyFrames to play keyFrames) Play a animation involving the given keyframes.
protected void	animate(Animation The animation to play animation) Play the given animation on every frame of the animation the chart will be relayed out until the animation finishes.
public final BooleanProperty	animatedProperty()
protected double	computeMinHeight(double the width that should be used if min height depends on it width) Overrides javafx.scene.layout.Region.computeMinHeight. Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
protected double	computeMinWidth(double the height that should be used if min width depends on it height) Overrides javafx.scene.layout.Region.computeMinWidth. Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
protected double	computePrefHeight(double the width that should be used if preferred height depends on it width) Overrides javafx.scene.layout.Region.computePrefHeight. Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
protected double	computePrefWidth(double the height that should be used if preferred width depends on it height) Overrides javafx.scene.layout.Region.computePrefWidth. Charts are sized outside in, user tells chart how much space it has and chart draws inside that.
public final boolean	Returns: true if data changes will be animated and false otherwise. getAnimated() Indicates whether data changes will be animated or not.
protected ObservableList<Node>	Returns: Observable list of plot children getChartChildren() Modifiable and observable list of all content in the chart.
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.
protected final Node	getLegend()
public final Side	getLegendSide()
public final String	getTitle()
public final Side	getTitleSide()
public final boolean	isLegendVisible()
protected abstract void	layoutChartChildren(double The top offset from the origin to account for any padding on the chart content top, double The left offset from the origin to account for any padding on the chart content left, double The width of the area to layout the chart within width, double The height of the area to layout the chart within height) Called to update and layout the chart children available from getChartChildren()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout this chart and all its content.
protected final ObjectProperty<Node>	legendProperty()
public final ObjectProperty<Side>	legendSideProperty()
public final BooleanProperty	legendVisibleProperty()
protected void	requestChartLayout() Call this when you know something has changed that needs the chart to be relayed out.
public final void	setAnimated(boolean value)
protected final void	setLegend(Node value)
public final void	setLegendSide(Side value)
public final void	setLegendVisible(boolean value)
public final void	setTitle(String value)
public final void	setTitleSide(Side value)
protected final boolean	Returns: true if animation is enabled and the node is visible and in a scene shouldAnimate() This is used to check if any given animation should run.
public final StringProperty	titleProperty()
public final ObjectProperty<Side>	titleSideProperty()

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

Field Detail

animated	back to summary
private BooleanProperty animated When true any data changes will be animated.

animator	back to summary
private final ChartLayoutAnimator animator Animator for animating stuff on the chart

chartContent	back to summary
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.

legend	back to summary
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

legendSide	back to summary
private ObjectProperty<Side> legendSide The side of the chart where the legend should be displayed Default Value Side.BOTTOM

legendSide

back to summary

private ObjectProperty<Side> legendSide

The side of the chart where the legend should be displayed

Default Value: Side.BOTTOM

legendVisible	back to summary
private final BooleanProperty legendVisible When true the chart will display a legend if the chart implementation supports a legend.

MIN_HEIGHT_TO_LEAVE_FOR_CHART_CONTENT	back to summary
private static final int MIN_HEIGHT_TO_LEAVE_FOR_CHART_CONTENT

MIN_WIDTH_TO_LEAVE_FOR_CHART_CONTENT	back to summary
private static final int MIN_WIDTH_TO_LEAVE_FOR_CHART_CONTENT

title	back to summary
private StringProperty title The chart title

titleLabel	back to summary
private final Label titleLabel Title Label

titleSide	back to summary
private ObjectProperty<Side> titleSide The side of the chart where the title is displayed Default Value Side.TOP

titleSide

back to summary

private ObjectProperty<Side> titleSide

The side of the chart where the title is displayed

Default Value: Side.TOP

useChartContentMirroring	back to summary
pack-priv boolean useChartContentMirroring

Constructor Detail

Chart	back to summary
public Chart() Creates a new default Chart instance.

Method Detail

animate	back to summary
pack-priv 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:KeyFrame[] Array of KeyFrames to play

animate

back to summary

pack-priv 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:KeyFrame[]: Array of KeyFrames to play

animate	back to summary
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:Animation The animation to play

animate

back to summary

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:Animation: The animation to play

animatedProperty	back to summary
public final BooleanProperty animatedProperty()

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. 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. Parameters width:double Doc from javafx.scene.Parent.computeMinHeight. the width that should be used if min height depends on it Returns:double Doc from javafx.scene.layout.Region.computeMinHeight. the computed minimum height for this region Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

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.

Parameters

width:double

Doc from javafx.scene.Parent.computeMinHeight.

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

Returns:double

Doc from javafx.scene.layout.Region.computeMinHeight.

the computed minimum height for this region

Annotations

@Override

computeMinWidth	back to summary
protected double computeMinWidth(double height) Overrides javafx.scene.layout.Region.computeMinWidth. 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. Parameters height:double Doc from javafx.scene.Parent.computeMinWidth. the height that should be used if min width depends on it Returns:double Doc from javafx.scene.layout.Region.computeMinWidth. the computed minimum width of this region Annotations @Override

computeMinWidth

back to summary

protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

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.

Parameters

height:double

Doc from javafx.scene.Parent.computeMinWidth.

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

Returns:double

Doc from javafx.scene.layout.Region.computeMinWidth.

the computed minimum width of this region

Annotations

@Override

computePrefHeight	back to summary
protected double computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. 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. Parameters width:double Doc from javafx.scene.Parent.computePrefHeight. the width that should be used if preferred height depends on it Returns:double Doc from javafx.scene.layout.Region.computePrefHeight. the computed preferred height for this region Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

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.

Parameters

width:double

Doc from javafx.scene.Parent.computePrefHeight.

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

Returns:double

Doc from javafx.scene.layout.Region.computePrefHeight.

the computed preferred height for this region

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. 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. Parameters height:double Doc from javafx.scene.Parent.computePrefWidth. the height that should be used if preferred width depends on it Returns:double Doc from javafx.scene.layout.Region.computePrefWidth. the computed preferred width for this region Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

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.

Parameters

height:double

Doc from javafx.scene.Parent.computePrefWidth.

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

Returns:double

Doc from javafx.scene.layout.Region.computePrefWidth.

the computed preferred width for this region

Annotations

@Override

getAnimated	back to summary
public final boolean getAnimated() Indicates whether data changes will be animated or not. Returns:boolean true if data changes will be animated and false otherwise.

getAnimated

back to summary

public final boolean getAnimated()

Indicates whether data changes will be animated or not.

Returns:boolean: true if data changes will be animated and false otherwise.

getChartChildren	back to summary
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:ObservableList<Node> Observable list of plot children

getChartChildren

back to summary

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:ObservableList<Node>: Observable list of plot children

getClassCssMetaData back to summary

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

Hides javafx.scene.layout.Region.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.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.layout.Region.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

getLegend	back to summary
protected final Node getLegend()

getLegendSide	back to summary
public final Side getLegendSide()

getTitle	back to summary
public final String getTitle()

getTitleSide	back to summary
public final Side getTitleSide()

isLegendVisible	back to summary
public final boolean isLegendVisible()

layoutChartChildren	back to summary
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:double The top offset from the origin to account for any padding on the chart content left:double The left offset from the origin to account for any padding on the chart content width:double The width of the area to layout the chart within height:double The height of the area to layout the chart within

layoutChartChildren

back to summary

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:double: The top offset from the origin to account for any padding on the chart content
left:double: The left offset from the origin to account for any padding on the chart content
width:double: The width of the area to layout the chart within
height:double: The height of the area to layout the chart within

layoutChildren	back to summary
protected void layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout this chart and all its content. Annotations @Override

layoutChildren

back to summary

protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

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

Annotations

@Override

legendProperty	back to summary
protected final ObjectProperty<Node> legendProperty()

legendSideProperty	back to summary
public final ObjectProperty<Side> legendSideProperty()

legendVisibleProperty	back to summary
public final BooleanProperty legendVisibleProperty()

requestChartLayout	back to summary
protected void requestChartLayout() Call this when you know something has changed that needs the chart to be relayed out.

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

setLegend	back to summary
protected final void setLegend(Node value)

setLegendSide	back to summary
public final void setLegendSide(Side value)

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

setTitle	back to summary
public final void setTitle(String value)

setTitleSide	back to summary
public final void setTitleSide(Side value)

shouldAnimate	back to summary
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. Returns:boolean true if animation is enabled and the node is visible and in a scene

shouldAnimate

back to summary

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.

Returns:boolean: true if animation is enabled and the node is visible and in a scene

titleProperty	back to summary
public final StringProperty titleProperty()

titleSideProperty	back to summary
public final ObjectProperty<Side> titleSideProperty()

Modifier and Type	Field and Description
private static final CssMetaData<Chart, Side>	LEGEND_SIDE
private static final CssMetaData<Chart, Boolean>	LEGEND_VISIBLE
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES
private static final CssMetaData<Chart, Side>	TITLE_SIDE

public abstract Class Chart

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Chart.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail