Module javafx.controls
Package javafx.scene.chart

Class XYChart<X,​Y>

  • All Implemented Interfaces:
    Styleable, EventTarget
    Direct Known Subclasses:
    AreaChart, BarChart, BubbleChart, LineChart, ScatterChart, StackedAreaChart, StackedBarChart
    public abstract class XYChart<X,​Y>
extends Chart
    Chart base class for all 2 axis charts. It is responsible for drawing the two axes and the plot content. It contains a list of all content in the plot and implementations of XYChart can add nodes to this list that need to be rendered.

    It is possible to install Tooltips on data items / symbols. For example the following code snippet installs Tooltip on the 1st data item. 

    
  XYChart.Data item = ( XYChart.Data)series.getData().get(0);
  Tooltip.install(item.getNode(), new Tooltip("Symbol-0"));
    Since:
    JavaFX 2.0

    • Constructor Detail

      • XYChart

        public XYChart​(Axis<X> xAxis,
               Axis<Y> yAxis)
        Constructs a XYChart given the two axes. The initial content for the chart plot background and plot area that includes vertical and horizontal grid lines and fills, are added.
        Parameters:
        xAxis - X Axis for this XY chart
        yAxis - Y Axis for this XY chart

    • Method Detail

      • getXAxis

        public Axis<X> getXAxis()
        Get the X axis, by default it is along the bottom of the plot
        Returns:
        the X axis of the chart

      • getYAxis

        public Axis<Y> getYAxis()
        Get the Y axis, by default it is along the left of the plot
        Returns:
        the Y axis of this chart

      • setData

        public final void setData​(ObservableList<XYChart.Series<X,​Y>> value)
        Sets the value of the property data.
        Property description:
        XYCharts data

      • getVerticalGridLinesVisible

        public final boolean getVerticalGridLinesVisible()
        Indicates whether vertical grid lines are visible or not.
        Returns:
        true if verticalGridLines are visible else false.
        See Also:
        verticalGridLinesVisibleProperty()

      • setVerticalGridLinesVisible

        public final void setVerticalGridLinesVisible​(boolean value)
        Sets the value of the property verticalGridLinesVisible.
        Property description:
        True if vertical grid lines should be drawn

      • isHorizontalGridLinesVisible

        public final boolean isHorizontalGridLinesVisible()
        Gets the value of the property horizontalGridLinesVisible.
        Property description:
        True if horizontal grid lines should be drawn

      • setHorizontalGridLinesVisible

        public final void setHorizontalGridLinesVisible​(boolean value)
        Sets the value of the property horizontalGridLinesVisible.
        Property description:
        True if horizontal grid lines should be drawn

      • isAlternativeColumnFillVisible

        public final boolean isAlternativeColumnFillVisible()
        Gets the value of the property alternativeColumnFillVisible.
        Property description:
        If true then alternative vertical columns will have fills

      • setAlternativeColumnFillVisible

        public final void setAlternativeColumnFillVisible​(boolean value)
        Sets the value of the property alternativeColumnFillVisible.
        Property description:
        If true then alternative vertical columns will have fills

      • isAlternativeRowFillVisible

        public final boolean isAlternativeRowFillVisible()
        Gets the value of the property alternativeRowFillVisible.
        Property description:
        If true then alternative horizontal rows will have fills

      • setAlternativeRowFillVisible

        public final void setAlternativeRowFillVisible​(boolean value)
        Sets the value of the property alternativeRowFillVisible.
        Property description:
        If true then alternative horizontal rows will have fills

      • isVerticalZeroLineVisible

        public final boolean isVerticalZeroLineVisible()
        Gets the value of the property verticalZeroLineVisible.
        Property description:
        If this is true and the vertical axis has both positive and negative values then a additional axis line will be drawn at the zero point
        Default value:
        true

      • setVerticalZeroLineVisible

        public final void setVerticalZeroLineVisible​(boolean value)
        Sets the value of the property verticalZeroLineVisible.
        Property description:
        If this is true and the vertical axis has both positive and negative values then a additional axis line will be drawn at the zero point
        Default value:
        true

      • isHorizontalZeroLineVisible

        public final boolean isHorizontalZeroLineVisible()
        Gets the value of the property horizontalZeroLineVisible.
        Property description:
        If this is true and the horizontal axis has both positive and negative values then a additional axis line will be drawn at the zero point
        Default value:
        true

      • setHorizontalZeroLineVisible

        public final void setHorizontalZeroLineVisible​(boolean value)
        Sets the value of the property horizontalZeroLineVisible.
        Property description:
        If this is true and the horizontal axis has both positive and negative values then a additional axis line will be drawn at the zero point
        Default value:
        true

      • getPlotChildren

        protected ObservableList<Node> getPlotChildren()
        Modifiable and observable list of all content in the plot. This is where implementations of XYChart should add any nodes they use to draw their plot.
        Returns:
        Observable list of plot children

      • updateLegend

        protected void updateLegend()
        This is called whenever a series is added or removed and the legend needs to be updated

      • dataItemAdded

        protected abstract 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. 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 - 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 abstract 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. 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 - The item that has been removed from the series
        series - The series the item was removed from

      • dataItemChanged

        protected abstract void dataItemChanged​(XYChart.Data<X,​Y> item)
        Called when a data item has changed, ie its xValue, yValue or extraValue has changed.
        Parameters:
        item - The data item who was changed

      • seriesAdded

        protected abstract 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.
        Parameters:
        series - The series that has been added
        seriesIndex - The index of the new series

      • seriesRemoved

        protected abstract void seriesRemoved​(XYChart.Series<X,​Y> series)
        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 - The series that has been removed

      • seriesChanged

        protected void seriesChanged​(ListChangeListener.Change<? extends XYChart.Series> c)
        Called when each atomic change is made to the list of series for this chart
        Parameters:
        c - a Change instance representing the changes to the series

      • 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.

      • layoutPlotChildren

        protected abstract 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.

      • layoutChartChildren

        protected final void layoutChartChildren​(double top,
                                         double left,
                                         double width,
                                         double height)
        Called to update and layout the chart children available from getChartChildren()
        Specified by:
        layoutChartChildren in class Chart
        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

      • removeSeriesFromDisplay

        protected final void removeSeriesFromDisplay​(XYChart.Series<X,​Y> series)
        This should be called from seriesRemoved() when you are finished with any animation for deleting the series from the chart. It will remove the series from showing up in the Iterator returned by getDisplayedSeriesIterator().
        Parameters:
        series - The series to remove

      • getDisplayedSeriesIterator

        protected final Iterator<XYChart.Series<X,​Y>> getDisplayedSeriesIterator()
        XYChart maintains a list of all series currently displayed this includes all current series + any series that have recently been deleted that are in the process of being faded(animated) out. This creates and returns a iterator over that list. This is what implementations of XYChart should use when plotting data.
        Returns:
        iterator over currently displayed series

      • getCurrentDisplayedXValue

        protected final X getCurrentDisplayedXValue​(XYChart.Data<X,​Y> item)
        The current displayed data value plotted on the X axis. This may be the same as xValue or different. It is used by XYChart to animate the xValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.
        Parameters:
        item - The XYChart.Data item from which the current X axis data value is obtained
        Returns:
        The current displayed X data value

      • setCurrentDisplayedXValue

        protected final void setCurrentDisplayedXValue​(XYChart.Data<X,​Y> item,
                                               X value)
        Set the current displayed data value plotted on X axis.
        Parameters:
        item - The XYChart.Data item from which the current X axis data value is obtained.
        value - The X axis data value
        See Also:
        getCurrentDisplayedXValue(Data)

      • currentDisplayedXValueProperty

        protected final ObjectProperty<X> currentDisplayedXValueProperty​(XYChart.Data<X,​Y> item)
        The current displayed data value property that is plotted on X axis.
        Parameters:
        item - The XYChart.Data item from which the current X axis data value property object is obtained.
        Returns:
        The current displayed X data value ObjectProperty.
        See Also:
        getCurrentDisplayedXValue(Data)

      • getCurrentDisplayedYValue

        protected final Y getCurrentDisplayedYValue​(XYChart.Data<X,​Y> item)
        The current displayed data value plotted on the Y axis. This may be the same as yValue or different. It is used by XYChart to animate the yValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.
        Parameters:
        item - The XYChart.Data item from which the current Y axis data value is obtained
        Returns:
        The current displayed Y data value

      • setCurrentDisplayedYValue

        protected final void setCurrentDisplayedYValue​(XYChart.Data<X,​Y> item,
                                               Y value)
        Set the current displayed data value plotted on Y axis.
        Parameters:
        item - The XYChart.Data item from which the current Y axis data value is obtained.
        value - The Y axis data value
        See Also:
        getCurrentDisplayedYValue(Data)

      • currentDisplayedYValueProperty

        protected final ObjectProperty<Y> currentDisplayedYValueProperty​(XYChart.Data<X,​Y> item)
        The current displayed data value property that is plotted on Y axis.
        Parameters:
        item - The XYChart.Data item from which the current Y axis data value property object is obtained.
        Returns:
        The current displayed Y data value ObjectProperty.
        See Also:
        getCurrentDisplayedYValue(Data)

      • getCurrentDisplayedExtraValue

        protected final Object getCurrentDisplayedExtraValue​(XYChart.Data<X,​Y> item)
        The current displayed data extra value. This may be the same as extraValue or different. It is used by XYChart to animate the extraValue from the old value to the new value. This is what you should plot in any custom XYChart implementations.
        Parameters:
        item - The XYChart.Data item from which the current extra value is obtained
        Returns:
        The current extra value

      • setCurrentDisplayedExtraValue

        protected final void setCurrentDisplayedExtraValue​(XYChart.Data<X,​Y> item,
                                                   Object value)
        Set the current displayed data extra value.
        Parameters:
        item - The XYChart.Data item from which the current extra value is obtained.
        value - The extra value
        See Also:
        getCurrentDisplayedExtraValue(Data)

      • currentDisplayedExtraValueProperty

        protected final ObjectProperty<Object> currentDisplayedExtraValueProperty​(XYChart.Data<X,​Y> item)
        The current displayed extra value property.
        Parameters:
        item - The XYChart.Data item from which the current extra value property object is obtained.
        Returns:
        ObjectProperty<Object> The current extra value ObjectProperty
        See Also:
        getCurrentDisplayedExtraValue(Data)

      • getDisplayedDataIterator

        protected final Iterator<XYChart.Data<X,​Y>> getDisplayedDataIterator​(XYChart.Series<X,​Y> series)
        XYChart maintains a list of all items currently displayed this includes all current data + any data items recently deleted that are in the process of being faded out. This creates and returns a iterator over that list. This is what implementations of XYChart should use when plotting data.
        Parameters:
        series - The series to get displayed data for
        Returns:
        iterator over currently displayed items from this series

      • removeDataItemFromDisplay

        protected final void removeDataItemFromDisplay​(XYChart.Series<X,​Y> series,
                                               XYChart.Data<X,​Y> item)
        This should be called from dataItemRemoved() when you are finished with any animation for deleting the item from the chart. It will remove the data item from showing up in the Iterator returned by getDisplayedDataIterator().
        Parameters:
        series - The series to remove
        item - The item to remove from series's display list

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,​?>> getClassCssMetaData()
        Returns:
        The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
        Since:
        JavaFX 8.0