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

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

Modifier and Type	Field and Description
private ListChangeListener<String>	categoriesListener
private CategoryAxis	categoryAxis
private DoubleProperty	categoryGap The gap to leave between bars in separate categories
private static final PseudoClass	HORIZONTAL_PSEUDOCLASS_STATE Pseudoclass indicating this is a horizontal chart.
private final Orientation	orientation
private ParallelTransition	parallelTransition
private Map<XYChart.Series<X, Y>, Map<String, List<XYChart.Data<X, Y>>>>	seriesCategoryMap
private ValueAxis<T extends Number>	valueAxis
private static final PseudoClass	VERTICAL_PSEUDOCLASS_STATE Pseudoclass indicating this is a vertical chart.

Access	Constructor and Description
public	StackedBarChart(Axis<X> The x axis to use xAxis, Axis<Y> The y axis to use yAxis) Construct a new StackedBarChart with the given axis.
public	StackedBarChart(Axis<X> The x axis to use xAxis, Axis<Y> The y axis to use yAxis, ObservableList<XYChart.Series<X, Y>> The data to use, this is the actual list used so any changes to it will be reflected in the chart data) Construct a new StackedBarChart with the given axis and data.
public	StackedBarChart(Axis<X> The x axis to use xAxis, Axis<Y> The y axis to use yAxis, ObservableList<XYChart.Series<X, Y>> The data to use, this is the actual list used so any changes to it will be reflected in the chart data, double The gap to leave between bars in separate categories 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)
public DoubleProperty	categoryGapProperty()
private Node	createBar(XYChart.Series<X, Y> series, int seriesIndex, final XYChart.Data<X, Y> item, int itemIndex)
private Timeline	createDataRemoveTimeline(XYChart.Data<X, Y> item, final Node bar, final XYChart.Series<X, Y> series)
pack-priv Legend.LegendItem	createLegendItemForSeries(XYChart.Series<X, Y> the series for this legend item series, int the index of the series seriesIndex) Overrides javafx.scene.chart.XYChart.createLegendItemForSeries. Called by the updateLegend for each series in the chart in order to create new legend item
protected void	dataItemAdded(XYChart.Series<X, Y> The series the data item was added to series, int The index of the new item within the series itemIndex, XYChart.Data<X, Y> The new data item that was added item) Implements abstract javafx.scene.chart.XYChart.dataItemAdded. Called when a data item has been added to a series.
protected void	dataItemChanged(XYChart.Data<X, Y> The data item who was changed item) Implements abstract javafx.scene.chart.XYChart.dataItemChanged. Called when a data item has changed, ie its xValue, yValue or extraValue has changed.
protected void	dataItemRemoved(final XYChart.Data<X, Y> The item that has been removed from the series item, final XYChart.Series<X, Y> The series the item was removed from series) Implements abstract javafx.scene.chart.XYChart.dataItemRemoved. Called when a data item has been removed from data model but it is still visible on the chart.
public double	getCategoryGap()
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.chart.XYChart.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.chart.XYChart.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.
private List<XYChart.Data<X, Y>>	getDataItem(XYChart.Series<X, Y> series, String category)
protected void	layoutPlotChildren() Implements abstract javafx.scene.chart.XYChart.layoutPlotChildren. Called to update and layout the plot children.
private void	processDataRemove(final XYChart.Series<X, Y> series, final XYChart.Data<X, Y> item)
protected void	seriesAdded(XYChart.Series<X, Y> The series that has been added series, int The index of the new series seriesIndex) Implements abstract javafx.scene.chart.XYChart.seriesAdded. A series has been added to the charts data model.
pack-priv void	seriesBeingRemovedIsAdded(XYChart.Series<X, Y> series) Overrides javafx.scene.chart.XYChart.seriesBeingRemovedIsAdded. This method is called when there is an attempt to add series that was set to be removed, and the removal might not have completed.
protected void	seriesChanged(ListChangeListener.Change<? extends XYChart.Series<X, Y>> a Change instance representing the changes to the series c) Overrides javafx.scene.chart.XYChart.seriesChanged. Called when each atomic change is made to the list of series for this chart
protected void	seriesRemoved(final XYChart.Series<X, Y> The series that has been removed series) Implements abstract javafx.scene.chart.XYChart.seriesRemoved. A series has been removed from the data model but it is still visible on the chart.
public void	setCategoryGap(double value)
protected void	updateAxisRange() Overrides javafx.scene.chart.XYChart.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)

Inherited from 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 setAlternativeColumnFillVisible setAlternativeRowFillVisible setCurrentDisplayedExtraValue setCurrentDisplayedXValue setCurrentDisplayedYValue setData setHorizontalGridLinesVisible setHorizontalZeroLineVisible setVerticalGridLinesVisible setVerticalZeroLineVisible updateLegend verticalGridLinesVisibleProperty verticalZeroLineVisibleProperty

Field Detail

categoriesListener	back to summary
private ListChangeListener<String> categoriesListener

categoryAxis	back to summary
private CategoryAxis categoryAxis

categoryGap	back to summary
private DoubleProperty categoryGap The gap to leave between bars in separate categories

HORIZONTAL_PSEUDOCLASS_STATE	back to summary
private static final PseudoClass HORIZONTAL_PSEUDOCLASS_STATE Pseudoclass indicating this is a horizontal chart.

orientation	back to summary
private final Orientation orientation

parallelTransition	back to summary
private ParallelTransition parallelTransition

seriesCategoryMap	back to summary
private Map<XYChart.Series<X, Y>, Map<String, List<XYChart.Data<X, Y>>>> seriesCategoryMap

valueAxis	back to summary
private ValueAxis<T extends Number> valueAxis

VERTICAL_PSEUDOCLASS_STATE	back to summary
private static final PseudoClass VERTICAL_PSEUDOCLASS_STATE Pseudoclass indicating this is a vertical chart.

Constructor Detail

StackedBarChart	back to summary
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:Axis<X> The x axis to use yAxis:Axis<Y> The y axis to use

StackedBarChart

back to summary

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:Axis<X>: The x axis to use
yAxis:Axis<Y>: The y axis to use

StackedBarChart	back to summary
public StackedBarChart(Axis<X> xAxis, Axis<Y> yAxis, ObservableList<XYChart.Series<X, Y>> 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:Axis<X> The x axis to use yAxis:Axis<Y> The y axis to use data:ObservableList<XYChart.Series<X, Y>> The data to use, this is the actual list used so any changes to it will be reflected in the chart

StackedBarChart

back to summary

public StackedBarChart(Axis<X> xAxis, Axis<Y> yAxis, ObservableList<XYChart.Series<X, Y>> 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:Axis<X>: The x axis to use
yAxis:Axis<Y>: The y axis to use
data:ObservableList<XYChart.Series<X, Y>>: The data to use, this is the actual list used so any changes to it will be reflected in the chart

StackedBarChart	back to summary
public StackedBarChart(Axis<X> xAxis, Axis<Y> yAxis, ObservableList<XYChart.Series<X, Y>> 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:Axis<X> The x axis to use yAxis:Axis<Y> The y axis to use data:ObservableList<XYChart.Series<X, Y>> The data to use, this is the actual list used so any changes to it will be reflected in the chart categoryGap:double The gap to leave between bars in separate categories

StackedBarChart

back to summary

public StackedBarChart(Axis<X> xAxis, Axis<Y> yAxis, ObservableList<XYChart.Series<X, Y>> data, double categoryGap)

Parameters

xAxis:Axis<X>: The x axis to use
yAxis:Axis<Y>: The y axis to use
data:ObservableList<XYChart.Series<X, Y>>: The data to use, this is the actual list used so any changes to it will be reflected in the chart
categoryGap:double: The gap to leave between bars in separate categories

Method Detail

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

categoryGapProperty	back to summary
public DoubleProperty categoryGapProperty()

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

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

createLegendItemForSeries	back to summary
pack-priv Legend.LegendItem createLegendItemForSeries(XYChart.Series<X, Y> series, int seriesIndex) Overrides javafx.scene.chart.XYChart.createLegendItemForSeries. Doc from javafx.scene.chart.XYChart.createLegendItemForSeries. Called by the updateLegend for each series in the chart in order to create new legend item Parameters series:XYChart.Series<X, Y> the series for this legend item seriesIndex:int the index of the series Returns:Legend.LegendItem new legend item for this series Annotations @Override

createLegendItemForSeries

back to summary

pack-priv Legend.LegendItem createLegendItemForSeries(XYChart.Series<X, Y> series, int seriesIndex)

Overrides javafx.scene.chart.XYChart.createLegendItemForSeries.

Doc from javafx.scene.chart.XYChart.createLegendItemForSeries.

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

Parameters

series:XYChart.Series<X, Y>: the series for this legend item
seriesIndex:int: the index of the series

Returns:Legend.LegendItem

new legend item for this series

Annotations

@Override

dataItemAdded	back to summary
protected void dataItemAdded(XYChart.Series<X, Y> series, int itemIndex, XYChart.Data<X, Y> item) Implements abstract javafx.scene.chart.XYChart.dataItemAdded. Doc from javafx.scene.chart.XYChart.dataItemAdded. 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. Parameters series:XYChart.Series<X, Y> The series the data item was added to itemIndex:int The index of the new item within the series item:XYChart.Data<X, Y> The new data item that was added Annotations @Override

dataItemChanged	back to summary
protected void dataItemChanged(XYChart.Data<X, Y> item) Implements abstract javafx.scene.chart.XYChart.dataItemChanged. Doc from javafx.scene.chart.XYChart.dataItemChanged. Called when a data item has changed, ie its xValue, yValue or extraValue has changed. Parameters item:XYChart.Data<X, Y> The data item who was changed Annotations @Override

dataItemRemoved	back to summary
protected void dataItemRemoved(final XYChart.Data<X, Y> item, final XYChart.Series<X, Y> series) Implements abstract javafx.scene.chart.XYChart.dataItemRemoved. Doc from javafx.scene.chart.XYChart.dataItemRemoved. 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. Parameters item:XYChart.Data<X, Y> The item that has been removed from the series series:XYChart.Series<X, Y> The series the item was removed from Annotations @Override

getCategoryGap	back to summary
public double getCategoryGap()

getClassCssMetaData back to summary

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

Hides javafx.scene.chart.XYChart.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.chart.XYChart.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.chart.XYChart.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

getDataItem	back to summary
private List<XYChart.Data<X, Y>> getDataItem(XYChart.Series<X, Y> series, String category)

layoutPlotChildren	back to summary
protected void layoutPlotChildren() Implements abstract javafx.scene.chart.XYChart.layoutPlotChildren. Doc from javafx.scene.chart.XYChart.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. Annotations @Override

layoutPlotChildren

back to summary

protected void layoutPlotChildren()

Implements abstract javafx.scene.chart.XYChart.layoutPlotChildren.

Doc from javafx.scene.chart.XYChart.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.

Annotations

@Override

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

seriesAdded	back to summary
protected void seriesAdded(XYChart.Series<X, Y> series, int seriesIndex) Implements abstract javafx.scene.chart.XYChart.seriesAdded. Doc from javafx.scene.chart.XYChart.seriesAdded. 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. Parameters series:XYChart.Series<X, Y> The series that has been added seriesIndex:int The index of the new series Annotations @Override

seriesAdded

back to summary

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

Implements abstract javafx.scene.chart.XYChart.seriesAdded.

Doc from javafx.scene.chart.XYChart.seriesAdded.

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.

Parameters

series:XYChart.Series<X, Y>: The series that has been added
seriesIndex:int: The index of the new series

Annotations

@Override

seriesBeingRemovedIsAdded	back to summary
pack-priv void seriesBeingRemovedIsAdded(XYChart.Series<X, Y> series) Overrides javafx.scene.chart.XYChart.seriesBeingRemovedIsAdded. Doc from javafx.scene.chart.XYChart.seriesBeingRemovedIsAdded. This method is called when there is an attempt to add series that was set to be removed, and the removal might not have completed. Annotations @Override

seriesBeingRemovedIsAdded

back to summary

pack-priv void seriesBeingRemovedIsAdded(XYChart.Series<X, Y> series)

Overrides javafx.scene.chart.XYChart.seriesBeingRemovedIsAdded.

Doc from javafx.scene.chart.XYChart.seriesBeingRemovedIsAdded.

This method is called when there is an attempt to add series that was set to be removed, and the removal might not have completed.

Annotations

@Override

seriesChanged	back to summary
protected void seriesChanged(ListChangeListener.Change<? extends XYChart.Series<X, Y>> c) Overrides javafx.scene.chart.XYChart.seriesChanged. Doc from javafx.scene.chart.XYChart.seriesChanged. Called when each atomic change is made to the list of series for this chart Parameters c:ListChangeListener.Change<? extends XYChart.Series<X, Y>> a Change instance representing the changes to the series Annotations @Override

seriesChanged

back to summary

protected void seriesChanged(ListChangeListener.Change<? extends XYChart.Series<X, Y>> c)

Overrides javafx.scene.chart.XYChart.seriesChanged.

Doc from javafx.scene.chart.XYChart.seriesChanged.

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

Parameters

c:ListChangeListener.Change<? extends XYChart.Series<X, Y>>: a Change instance representing the changes to the series

Annotations

@Override

seriesRemoved	back to summary
protected void seriesRemoved(final XYChart.Series<X, Y> series) Implements abstract javafx.scene.chart.XYChart.seriesRemoved. Doc from javafx.scene.chart.XYChart.seriesRemoved. 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. Parameters series:XYChart.Series<X, Y> The series that has been removed Annotations @Override

seriesRemoved

back to summary

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

Implements abstract javafx.scene.chart.XYChart.seriesRemoved.

Doc from javafx.scene.chart.XYChart.seriesRemoved.

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.

Parameters

series:XYChart.Series<X, Y>: The series that has been removed

Annotations

@Override

setCategoryGap	back to summary
public void setCategoryGap(double value)

updateAxisRange	back to summary
protected void updateAxisRange() Overrides javafx.scene.chart.XYChart.updateAxisRange. Doc from javafx.scene.chart.XYChart.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. Annotations @Override

updateAxisRange

back to summary

protected void updateAxisRange()

Overrides javafx.scene.chart.XYChart.updateAxisRange.

Doc from javafx.scene.chart.XYChart.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.

Annotations

@Override

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

Modifier and Type	Field and Description
private static final CssMetaData<StackedBarChart<?, ?>, Number>	CATEGORY_GAP
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

public Class StackedBarChart<X, Y>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StackedBarChart.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail