javafx.scene.chart

Class StackedBarChart<X,Y>

java.lang.Object

Region

javafx.scene.chart.Chart

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

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

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

StackedBarChart is a variation of BarChart that plots bars indicating data values for a category. The bars can be vertical or horizontal depending on which axis is a category axis. The bar for each series is stacked on top of the previous series.

Since:

JavaFX 2.1

Property Summary

Type	Property and Description
DoubleProperty	categoryGap The gap to leave between bars in separate categories

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
private static class	StackedBarChart.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 <any>	categoriesListener
private CategoryAxis	categoryAxis
private DoubleProperty	categoryGap The gap to leave between bars in separate categories
private static PseudoClass	HORIZONTAL_PSEUDOCLASS_STATE Pseudoclass indicating this is a horizontal chart.
private Orientation	orientation
private java.util.Map<XYChart.Series<X,Y>,java.util.Map<java.lang.String,java.util.List<XYChart.Data<X,Y>>>>	seriesCategoryMap
private ValueAxis	valueAxis
private static PseudoClass	VERTICAL_PSEUDOCLASS_STATE Pseudoclass indicating this is a vertical chart.

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
StackedBarChart(Axis<X> xAxis, Axis<Y> yAxis) Construct a new StackedBarChart with the given axis.
StackedBarChart(Axis<X> xAxis, Axis<Y> yAxis, <any> data) Construct a new StackedBarChart with the given axis and data.
StackedBarChart(Axis<X> xAxis, Axis<Y> yAxis, <any> data, double categoryGap) Construct a new StackedBarChart with the given axis and data.

Method Summary

Modifier and Type	Method and Description
private void	animateDataAdd(XYChart.Data<X,Y> item, Node bar)
DoubleProperty	categoryGapProperty() The gap to leave between bars in separate categories
private Node	createBar(XYChart.Series<X,Y> series, int seriesIndex, XYChart.Data<X,Y> item, int itemIndex)
private Timeline	createDataRemoveTimeline(XYChart.Data<X,Y> item, Node bar, XYChart.Series<X,Y> series)
(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
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.
double	getCategoryGap() Gets the value of the property categoryGap.
static java.util.List<<any>>	getClassCssMetaData()
java.util.List<<any>>	getCssMetaData()
private java.util.List<XYChart.Data<X,Y>>	getDataItem(XYChart.Series<X,Y> series, java.lang.String category)
protected void	layoutPlotChildren() Called to update and layout the plot children.
private void	processDataRemove(XYChart.Series<X,Y> series, XYChart.Data<X,Y> item)
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	setCategoryGap(double value) Sets the value of the property categoryGap.
protected void	updateAxisRange() This is called when the range has been invalidated and we need to update it.
private void	updateMap(XYChart.Series<X,Y> series, XYChart.Data<X,Y> item)

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

categoryGap

public DoubleProperty categoryGapProperty

The gap to leave between bars in separate categories

See Also:

getCategoryGap(), setCategoryGap(double)

Field Detail

seriesCategoryMap

private java.util.Map<XYChart.Series<X,Y>,java.util.Map<java.lang.String,java.util.List<XYChart.Data<X,Y>>>> seriesCategoryMap

orientation

private final Orientation orientation

categoryAxis

private CategoryAxis categoryAxis

valueAxis

private ValueAxis valueAxis

categoriesListener

private <any> categoriesListener

categoryGap

private DoubleProperty categoryGap

The gap to leave between bars in separate categories

VERTICAL_PSEUDOCLASS_STATE

private static final PseudoClass VERTICAL_PSEUDOCLASS_STATE

Pseudoclass indicating this is a vertical chart.

HORIZONTAL_PSEUDOCLASS_STATE

private static final PseudoClass HORIZONTAL_PSEUDOCLASS_STATE

Pseudoclass indicating this is a horizontal chart.

Constructor Detail

StackedBarChart

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

Construct a new StackedBarChart with the given axis. The two axis should be a ValueAxis/NumberAxis and a CategoryAxis, they can be in either order depending on if you want a horizontal or vertical bar chart.

Parameters:

xAxis - The x axis to use

yAxis - The y axis to use

StackedBarChart

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

Construct a new StackedBarChart with the given axis and data. The two axis should be a ValueAxis/NumberAxis and a CategoryAxis, they can be in either order depending on if you want a horizontal or vertical bar chart.

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

StackedBarChart

public StackedBarChart(Axis<X> xAxis,
                       Axis<Y> yAxis,
                       <any> data,
                       double categoryGap)

Construct a new StackedBarChart with the given axis and data. The two axis should be a ValueAxis/NumberAxis and a CategoryAxis, they can be in either order depending on if you want a horizontal or vertical bar chart.

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

categoryGap - The gap to leave between bars in separate categories

Method Detail

getCategoryGap

public double getCategoryGap()

Gets the value of the property categoryGap.

setCategoryGap

public void setCategoryGap(double value)

Sets the value of the property categoryGap.

categoryGapProperty

public DoubleProperty categoryGapProperty()

The gap to leave between bars in separate categories

See Also:

getCategoryGap(), setCategoryGap(double)

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)

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>

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

updateMap

private void updateMap(XYChart.Series<X,Y> series,
                       XYChart.Data<X,Y> item)

processDataRemove

private void processDataRemove(XYChart.Series<X,Y> series,
                               XYChart.Data<X,Y> item)

animateDataAdd

private void animateDataAdd(XYChart.Data<X,Y> item,
                            Node bar)

createDataRemoveTimeline

private Timeline createDataRemoveTimeline(XYChart.Data<X,Y> item,
                                          Node bar,
                                          XYChart.Series<X,Y> series)

createBar

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

getDataItem

private java.util.List<XYChart.Data<X,Y>> getDataItem(XYChart.Series<X,Y> series,
                                                      java.lang.String category)

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