javafx.scene.chart

Class StackedAreaChart<X,Y>

java.lang.Object

Region

javafx.scene.chart.Chart

javafx.scene.chart.XYChart<X,Y>

javafx.scene.chart.StackedAreaChart<X,Y>

public class StackedAreaChart<X,Y>
extends XYChart<X,Y>

StackedAreaChart is a variation of AreaChart that displays trends of the contribution of each value. (over time e.g.) The areas are stacked so that each series adjoins but does not overlap the preceding series. This contrasts with the Area chart where each series overlays the preceding series. The cumulative nature of the StackedAreaChart gives an idea of the total Y data value at any given point along the X axis. Since data points across multiple series may not be common, StackedAreaChart interpolates values along the line joining the data points whenever necessary.

Since:

JavaFX 2.1

Property Summary

Type	Property and Description
BooleanProperty	createSymbols When true, CSS styleable symbols are created for any data items that don't have a symbol node specified.

Properties inherited from class javafx.scene.chart.XYChart

alternativeColumnFillVisibleProperty, alternativeRowFillVisibleProperty, dataProperty, horizontalGridLinesVisibleProperty, horizontalZeroLineVisibleProperty, verticalGridLinesVisibleProperty, verticalZeroLineVisibleProperty

Properties inherited from class javafx.scene.chart.Chart

animatedProperty, legendProperty, legendSideProperty, legendVisibleProperty, titleProperty, titleSideProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	StackedAreaChart.DataPointInfo<X,Y>
private static class	StackedAreaChart.PartOf
private static class	StackedAreaChart.StyleableProperties

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

XYChart.Data<X,Y>, XYChart.Series<X,Y>

Field Summary

Fields

Modifier and Type	Field and Description
private BooleanProperty	createSymbols When true, CSS styleable symbols are created for any data items that don't have a symbol node specified.
private java.util.Map<XYChart.Series<X,Y>,DoubleProperty>	seriesYMultiplierMap A multiplier for teh Y values that we store for each series, it is used to animate in a new series

Fields inherited from class javafx.scene.chart.XYChart

DEFAULT_COLOR, seriesColorMap

Fields inherited from class javafx.scene.chart.Chart

useChartContentMirroring

Constructor Summary

Constructors

Constructor and Description
StackedAreaChart(Axis<X> xAxis, Axis<Y> yAxis) Construct a new Area Chart with the given axis
StackedAreaChart(Axis<X> xAxis, Axis<Y> yAxis, <any> data) Construct a new Area Chart with the given axis and data.

Method Summary

Modifier and Type	Method and Description
private void	addDropDown(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> currentSeriesData, XYChart.Data<X,Y> item, X xValue, Y yValue, double x, double y)
private void	addPoint(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> currentSeriesData, XYChart.Data<X,Y> item, X xValue, Y yValue, double x, double y, StackedAreaChart.PartOf partof, boolean symbol, boolean lineTo)
(package private) LegendItem	createLegendItemForSeries(XYChart.Series<X,Y> series, int seriesIndex) Called by the updateLegend for each series in the chart in order to create new legend item
private Node	createSymbol(XYChart.Series<X,Y> series, int seriesIndex, XYChart.Data<X,Y> item, int itemIndex)
BooleanProperty	createSymbolsProperty() When true, CSS styleable symbols are created for any data items that don't have a symbol node specified.
protected void	dataItemAdded(XYChart.Series<X,Y> series, int itemIndex, XYChart.Data<X,Y> item) Called when a data item has been added to a series.
protected void	dataItemChanged(XYChart.Data<X,Y> item) Called when a data item has changed, ie its xValue, yValue or extraValue has changed.
protected void	dataItemRemoved(XYChart.Data<X,Y> item, XYChart.Series<X,Y> series) Called when a data item has been removed from data model but it is still visible on the chart.
private static double	doubleValue(java.lang.Number number)
private static double	doubleValue(java.lang.Number number, double nullDefault)
private int	findNextCurrent(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points, int index)
private int	findNextPrevious(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points, int index)
private int	findPreviousCurrent(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points, int index)
private int	findPreviousPrevious(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points, int index)
static java.util.List<<any>>	getClassCssMetaData()
boolean	getCreateSymbols() Indicates whether symbols for data points will be created or not.
java.util.List<<any>>	getCssMetaData()
private double	interpolate(double lowX, double lowY, double highX, double highY, double x)
protected void	layoutPlotChildren() Called to update and layout the plot children.
protected void	seriesAdded(XYChart.Series<X,Y> series, int seriesIndex) A series has been added to the charts data model.
protected void	seriesChanged(<any> c) Called when each atomic change is made to the list of series for this chart
protected void	seriesRemoved(XYChart.Series<X,Y> series) A series has been removed from the data model but it is still visible on the chart.
void	setCreateSymbols(boolean value) Sets the value of the property createSymbols.
private void	sortAggregateList(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> aggregateList)
protected void	updateAxisRange() This is called when the range has been invalidated and we need to update it.

Methods inherited from class javafx.scene.chart.XYChart

alternativeColumnFillVisibleProperty, alternativeRowFillVisibleProperty, createSeriesRemoveTimeLine, currentDisplayedExtraValueProperty, currentDisplayedXValueProperty, currentDisplayedYValueProperty, dataBeingRemovedIsAdded, dataProperty, getCurrentDisplayedExtraValue, getCurrentDisplayedXValue, getCurrentDisplayedYValue, getData, getDataSize, getDisplayedDataIterator, getDisplayedSeriesIterator, getPlotChildren, getSeriesIndex, getSeriesSize, getVerticalGridLinesVisible, getXAxis, getYAxis, horizontalGridLinesVisibleProperty, horizontalZeroLineVisibleProperty, isAlternativeColumnFillVisible, isAlternativeRowFillVisible, isHorizontalGridLinesVisible, isHorizontalZeroLineVisible, isVerticalZeroLineVisible, layoutChartChildren, removeDataItemFromDisplay, removeSeriesFromDisplay, seriesBeingRemovedIsAdded, setAlternativeColumnFillVisible, setAlternativeRowFillVisible, setCurrentDisplayedExtraValue, setCurrentDisplayedXValue, setCurrentDisplayedYValue, setData, setHorizontalGridLinesVisible, setHorizontalZeroLineVisible, setVerticalGridLinesVisible, setVerticalZeroLineVisible, updateLegend, verticalGridLinesVisibleProperty, verticalZeroLineVisibleProperty

Methods inherited from class javafx.scene.chart.Chart

animate, animate, animatedProperty, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAnimated, getChartChildren, getLegend, getLegendSide, getTitle, getTitleSide, isLegendVisible, layoutChildren, legendProperty, legendSideProperty, legendVisibleProperty, requestChartLayout, setAnimated, setLegend, setLegendSide, setLegendVisible, setTitle, setTitleSide, shouldAnimate, titleProperty, titleSideProperty

Methods inherited from class java.lang.Object

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

Property Detail

createSymbols

public final BooleanProperty createSymbolsProperty

When true, CSS styleable symbols are created for any data items that don't have a symbol node specified.

Since:

JavaFX 8.0

See Also:

getCreateSymbols(), setCreateSymbols(boolean)

Field Detail

seriesYMultiplierMap

private java.util.Map<XYChart.Series<X,Y>,DoubleProperty> seriesYMultiplierMap

A multiplier for teh Y values that we store for each series, it is used to animate in a new series

createSymbols

private BooleanProperty createSymbols

When true, CSS styleable symbols are created for any data items that don't have a symbol node specified.

Since:

JavaFX 8.0

Constructor Detail

StackedAreaChart

public StackedAreaChart(Axis<X> xAxis,
                        Axis<Y> yAxis)

Construct a new Area Chart with the given axis

Parameters:

xAxis - The x axis to use

yAxis - The y axis to use

StackedAreaChart

public StackedAreaChart(Axis<X> xAxis,
                        Axis<Y> yAxis,
                        <any> data)

Construct a new Area Chart with the given axis and data.

Note: yAxis must be a ValueAxis, otherwise IllegalArgumentException is thrown.

Parameters:

xAxis - The x axis to use

yAxis - The y axis to use

data - The data to use, this is the actual list used so any changes to it will be reflected in the chart

Throws:

java.lang.IllegalArgumentException - if yAxis is not a ValueAxis

Method Detail

getCreateSymbols

public final boolean getCreateSymbols()

Indicates whether symbols for data points will be created or not.

Returns:

true if symbols for data points will be created and false otherwise.

Since:

JavaFX 8.0

setCreateSymbols

public final void setCreateSymbols(boolean value)

Sets the value of the property createSymbols.

Since:

JavaFX 8.0

createSymbolsProperty

public final BooleanProperty createSymbolsProperty()

When true, CSS styleable symbols are created for any data items that don't have a symbol node specified.

Since:

JavaFX 8.0

See Also:

getCreateSymbols(), setCreateSymbols(boolean)

doubleValue

private static double doubleValue(java.lang.Number number)

doubleValue

private static double doubleValue(java.lang.Number number,
                                  double nullDefault)

dataItemAdded

protected void dataItemAdded(XYChart.Series<X,Y> series,
                             int itemIndex,
                             XYChart.Data<X,Y> item)

Description copied from class: XYChart

Called when a data item has been added to a series. This is where implementations of XYChart can create/add new nodes to getPlotChildren to represent this data item. They also may animate that data add with a fade in or similar if animated = true.

Specified by:

dataItemAdded in class XYChart<X,Y>

Parameters:

series - The series the data item was added to

itemIndex - The index of the new item within the series

item - The new data item that was added

dataItemRemoved

protected void dataItemRemoved(XYChart.Data<X,Y> item,
                               XYChart.Series<X,Y> series)

Description copied from class: XYChart

Called when a data item has been removed from data model but it is still visible on the chart. Its still visible so that you can handle animation for removing it in this method. After you are done animating the data item you must call removeDataItemFromDisplay() to remove the items node from being displayed on the chart.

Specified by:

dataItemRemoved in class XYChart<X,Y>

Parameters:

item - The item that has been removed from the series

series - The series the item was removed from

dataItemChanged

protected void dataItemChanged(XYChart.Data<X,Y> item)

Called when a data item has changed, ie its xValue, yValue or extraValue has changed.

Specified by:

dataItemChanged in class XYChart<X,Y>

Parameters:

item - The data item who was changed

seriesChanged

protected void seriesChanged(<any> c)

Description copied from class: XYChart

Called when each atomic change is made to the list of series for this chart

Overrides:

seriesChanged in class XYChart<X,Y>

Parameters:

c - a Change instance representing the changes to the series

seriesAdded

protected void seriesAdded(XYChart.Series<X,Y> series,
                           int seriesIndex)

Description copied from class: XYChart

A series has been added to the charts data model. This is where implementations of XYChart can create/add new nodes to getPlotChildren to represent this series. Also you have to handle adding any data items that are already in the series. You may simply call dataItemAdded() for each one or provide some different animation for a whole series being added.

Specified by:

seriesAdded in class XYChart<X,Y>

Parameters:

series - The series that has been added

seriesIndex - The index of the new series

seriesRemoved

protected void seriesRemoved(XYChart.Series<X,Y> series)

Description copied from class: XYChart

A series has been removed from the data model but it is still visible on the chart. Its still visible so that you can handle animation for removing it in this method. After you are done animating the data item you must call removeSeriesFromDisplay() to remove the series from the display list.

Specified by:

seriesRemoved in class XYChart<X,Y>

Parameters:

series - The series that has been removed

updateAxisRange

protected void updateAxisRange()

This is called when the range has been invalidated and we need to update it. If the axis are auto ranging then we compile a list of all data that the given axis has to plot and call invalidateRange() on the axis passing it that data.

Overrides:

updateAxisRange in class XYChart<X,Y>

layoutPlotChildren

protected void layoutPlotChildren()

Called to update and layout the plot children. This should include all work to updates nodes representing the plot on top of the axis and grid lines etc. The origin is the top left of the plot area, the plot area with can be got by getting the width of the x axis and its height from the height of the y axis.

Specified by:

layoutPlotChildren in class XYChart<X,Y>

addDropDown

private void addDropDown(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> currentSeriesData,
                         XYChart.Data<X,Y> item,
                         X xValue,
                         Y yValue,
                         double x,
                         double y)

addPoint

private void addPoint(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> currentSeriesData,
                      XYChart.Data<X,Y> item,
                      X xValue,
                      Y yValue,
                      double x,
                      double y,
                      StackedAreaChart.PartOf partof,
                      boolean symbol,
                      boolean lineTo)

findNextCurrent

private int findNextCurrent(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points,
                            int index)

findPreviousCurrent

private int findPreviousCurrent(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points,
                                int index)

findPreviousPrevious

private int findPreviousPrevious(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points,
                                 int index)

findNextPrevious

private int findNextPrevious(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> points,
                             int index)

sortAggregateList

private void sortAggregateList(java.util.ArrayList<StackedAreaChart.DataPointInfo<X,Y>> aggregateList)

interpolate

private double interpolate(double lowX,
                           double lowY,
                           double highX,
                           double highY,
                           double x)

createSymbol

private Node createSymbol(XYChart.Series<X,Y> series,
                          int seriesIndex,
                          XYChart.Data<X,Y> item,
                          int itemIndex)

createLegendItemForSeries

LegendItem createLegendItemForSeries(XYChart.Series<X,Y> series,
                                     int seriesIndex)

Description copied from class: XYChart

Called by the updateLegend for each series in the chart in order to create new legend item

Overrides:

createLegendItemForSeries in class XYChart<X,Y>

Parameters:

series - the series for this legend item

seriesIndex - the index of the series

Returns:

new legend item for this series

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 XYChart<X,Y>

Since:

JavaFX 8.0