Chart

java.lang.Object
- Region
- - javafx.scene.chart.Chart

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

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`BooleanProperty`	`animated` When true any data changes will be animated.
`protected <any>`	`legend` The node to display as the Legend.
`<any>`	`legendSide` The side of the chart where the legend should be displayed
`BooleanProperty`	`legendVisible` When true the chart will display a legend if the chart implementation supports a legend.
`StringProperty`	`title` The chart title
`<any>`	`titleSide` The side of the chart where the title is displayed

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class Chart.StyleableProperties

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 <any>`	`legend` The node to display as the Legend.
`private <any>`	`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 <any>`	`titleSide` The side of the chart where the title is displayed
`(package private) boolean`	`useChartContentMirroring`

Constructor Summary

Constructors
Constructor and Description

Chart()
Creates a new default Chart instance.

Constructors
Constructor and Description
`Chart()` Creates a new default Chart instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
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()` When true any data changes will be animated.
`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 <any>`	`getChartChildren()` Modifiable and observable list of all content in the chart.
`static java.util.List<<any>>`	`getClassCssMetaData()`
`java.util.List<<any>>`	`getCssMetaData()`
`protected Node`	`getLegend()` Gets the value of the property legend.
`Side`	`getLegendSide()` Gets the value of the property legendSide.
`java.lang.String`	`getTitle()` Gets the value of the property title.
`Side`	`getTitleSide()` Gets the value of the property titleSide.
`boolean`	`isLegendVisible()` Gets the value of the property legendVisible.
`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 <any>`	`legendProperty()` The node to display as the Legend.
`<any>`	`legendSideProperty()` The side of the chart where the legend should be displayed
`BooleanProperty`	`legendVisibleProperty()` When true the chart will display a legend if the chart implementation supports a legend.
`protected void`	`requestChartLayout()` Call this when you know something has changed that needs the chart to be relayed out.
`void`	`setAnimated(boolean value)` Sets the value of the property animated.
`protected void`	`setLegend(Node value)` Sets the value of the property legend.
`void`	`setLegendSide(Side value)` Sets the value of the property legendSide.
`void`	`setLegendVisible(boolean value)` Sets the value of the property legendVisible.
`void`	`setTitle(java.lang.String value)` Sets the value of the property title.
`void`	`setTitleSide(Side value)` Sets the value of the property titleSide.
`protected boolean`	`shouldAnimate()` This is used to check if any given animation should run.
`StringProperty`	`titleProperty()` The chart title
`<any>`	`titleSideProperty()` The side of the chart where the title is displayed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - title
```
public final StringProperty titleProperty
```
    The chart title
    
    See Also:
    
    getTitle(), setTitle(String)
  - titleSide
```
public final <any> titleSideProperty
```
    The side of the chart where the title is displayed
    
    See Also:
    
    getTitleSide(), setTitleSide(Side)
  - legend
```
protected final <any> legendProperty
```
    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
    
    See Also:
    
    getLegend(), setLegend(Node)
  - legendVisible
```
public final BooleanProperty legendVisibleProperty
```
    When true the chart will display a legend if the chart implementation supports a legend.
    
    See Also:
    
    isLegendVisible(), setLegendVisible(boolean)
  - legendSide
```
public final <any> legendSideProperty
```
    The side of the chart where the legend should be displayed
    
    See Also:
    
    getLegendSide(), setLegendSide(Side)
  - animated
```
public final BooleanProperty animatedProperty
```
    When true any data changes will be animated.
    
    See Also:
    
    getAnimated(), setAnimated(boolean)
- 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 <any> titleSide
```
    The side of the chart where the title is displayed
  - legend
```
private final <any> 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 <any> 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()
```
    Gets the value of the property title.
  - setTitle
```
public final void setTitle(java.lang.String value)
```
    Sets the value of the property title.
  - titleProperty
```
public final StringProperty titleProperty()
```
    The chart title
    
    See Also:
    
    getTitle(), setTitle(String)
  - getTitleSide
```
public final Side getTitleSide()
```
    Gets the value of the property titleSide.
  - setTitleSide
```
public final void setTitleSide(Side value)
```
    Sets the value of the property titleSide.
  - titleSideProperty
```
public final <any> titleSideProperty()
```
    The side of the chart where the title is displayed
    
    See Also:
    
    getTitleSide(), setTitleSide(Side)
  - getLegend
```
protected final Node getLegend()
```
    Gets the value of the property legend.
  - setLegend
```
protected final void setLegend(Node value)
```
    Sets the value of the property legend.
  - legendProperty
```
protected final <any> legendProperty()
```
    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
    
    See Also:
    
    getLegend(), setLegend(Node)
  - isLegendVisible
```
public final boolean isLegendVisible()
```
    Gets the value of the property legendVisible.
  - setLegendVisible
```
public final void setLegendVisible(boolean value)
```
    Sets the value of the property legendVisible.
  - legendVisibleProperty
```
public final BooleanProperty legendVisibleProperty()
```
    When true the chart will display a legend if the chart implementation supports a legend.
    
    See Also:
    
    isLegendVisible(), setLegendVisible(boolean)
  - getLegendSide
```
public final Side getLegendSide()
```
    Gets the value of the property legendSide.
  - setLegendSide
```
public final void setLegendSide(Side value)
```
    Sets the value of the property legendSide.
  - legendSideProperty
```
public final <any> legendSideProperty()
```
    The side of the chart where the legend should be displayed
    
    See Also:
    
    getLegendSide(), setLegendSide(Side)
  - 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)
```
    Sets the value of the property animated.
  - animatedProperty
```
public final BooleanProperty animatedProperty()
```
    When true any data changes will be animated.
    
    See Also:
    
    getAnimated(), setAnimated(boolean)
  - getChartChildren
```
protected <any> 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.
    
    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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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()
```
    Since:
    
    JavaFX 8.0

Class Chart

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

title

titleSide

legend

legendVisible

legendSide

animated

Field Detail

MIN_WIDTH_TO_LEAVE_FOR_CHART_CONTENT

MIN_HEIGHT_TO_LEAVE_FOR_CHART_CONTENT

titleLabel

chartContent

useChartContentMirroring

animator

title

titleSide

legend

legendVisible

legendSide

animated

Constructor Detail

Chart

Method Detail

getTitle

setTitle

titleProperty

getTitleSide

setTitleSide

titleSideProperty

getLegend

setLegend

legendProperty

isLegendVisible

setLegendVisible

legendVisibleProperty

getLegendSide

setLegendSide

legendSideProperty

getAnimated

setAnimated

animatedProperty

getChartChildren

animate

animate

requestChartLayout

shouldAnimate

layoutChartChildren

layoutChildren

computeMinHeight

computeMinWidth

computePrefWidth

computePrefHeight

getClassCssMetaData

getCssMetaData