com.aspose.words

Class ChartDataPointCollection

  • java.lang.Object
    • com.aspose.words.ChartDataPointCollection
  • All Implemented Interfaces:
    java.lang.Iterable
    public class ChartDataPointCollection 
    extends java.lang.Object

Represents collection of a ChartDataPoint.

Example:

Shows how to work with data points on a line chart.
@Test
public void chartDataPoint() throws Exception {
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    Shape shape = builder.insertChart(ChartType.LINE, 500.0, 350.0);
    Chart chart = shape.getChart();

    Assert.assertEquals(3, chart.getSeries().getCount());
    Assert.assertEquals("Series 1", chart.getSeries().get(0).getName());
    Assert.assertEquals("Series 2", chart.getSeries().get(1).getName());
    Assert.assertEquals("Series 3", chart.getSeries().get(2).getName());

    // Emphasize the chart's data points by making them appear as diamond shapes.
    for (ChartSeries series : chart.getSeries())
        applyDataPoints(series, 4, MarkerSymbol.DIAMOND, 15);

    // Smooth out the line that represents the first data series.
    chart.getSeries().get(0).setSmooth(true);

    // Verify that data points for the first series will not invert their colors if the value is negative.
    Iterator<ChartDataPoint> enumerator = chart.getSeries().get(0).getDataPoints().iterator();
    while (enumerator.hasNext()) {
        Assert.assertFalse(enumerator.next().getInvertIfNegative());
    }

    // For a cleaner looking graph, we can clear format individually.
    chart.getSeries().get(1).getDataPoints().get(2).clearFormat();

    // We can also strip an entire series of data points at once.
    chart.getSeries().get(2).getDataPoints().clearFormat();

    doc.save(getArtifactsDir() + "Charts.ChartDataPoint.docx");
}

/// <summary>
/// Applies a number of data points to a series.
/// </summary>
private static void applyDataPoints(ChartSeries series, int dataPointsCount, int markerSymbol, int dataPointSize) {
    for (int i = 0; i < dataPointsCount; i++) {
        ChartDataPoint point = series.getDataPoints().get(i);
        point.getMarker().setSymbol(markerSymbol);
        point.getMarker().setSize(dataPointSize);

        Assert.assertEquals(point.getIndex(), i);
    }
}

Property Getters/Setters Summary
intgetCount()
Returns the number of ChartDataPoint in this collection.
ChartDataPointget(int index)
Returns ChartDataPoint for the specified index.
 
Method Summary
ChartDataPointadd(int index)
Deprecated. Adds new ChartDataPoint at the specified index.
voidclear()
Deprecated. Clears format of all ChartDataPoint in this collection.
voidclearFormat()
Clears format of all ChartDataPoint in this collection.
java.util.Iterator<ChartDataPoint>iterator()
Returns an enumerator object.
voidremoveAt(int index)
Deprecated. Clears format of a ChartDataPoint at the specified index.
 

    • Property Getters/Setters Detail

      • getCount

        public int getCount()
        
        Returns the number of ChartDataPoint in this collection.

        Example:

        Shows how to work with data points on a line chart.
        @Test
        public void chartDataPoint() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            Shape shape = builder.insertChart(ChartType.LINE, 500.0, 350.0);
            Chart chart = shape.getChart();
        
            Assert.assertEquals(3, chart.getSeries().getCount());
            Assert.assertEquals("Series 1", chart.getSeries().get(0).getName());
            Assert.assertEquals("Series 2", chart.getSeries().get(1).getName());
            Assert.assertEquals("Series 3", chart.getSeries().get(2).getName());
        
            // Emphasize the chart's data points by making them appear as diamond shapes.
            for (ChartSeries series : chart.getSeries())
                applyDataPoints(series, 4, MarkerSymbol.DIAMOND, 15);
        
            // Smooth out the line that represents the first data series.
            chart.getSeries().get(0).setSmooth(true);
        
            // Verify that data points for the first series will not invert their colors if the value is negative.
            Iterator<ChartDataPoint> enumerator = chart.getSeries().get(0).getDataPoints().iterator();
            while (enumerator.hasNext()) {
                Assert.assertFalse(enumerator.next().getInvertIfNegative());
            }
        
            // For a cleaner looking graph, we can clear format individually.
            chart.getSeries().get(1).getDataPoints().get(2).clearFormat();
        
            // We can also strip an entire series of data points at once.
            chart.getSeries().get(2).getDataPoints().clearFormat();
        
            doc.save(getArtifactsDir() + "Charts.ChartDataPoint.docx");
        }
        
        /// <summary>
        /// Applies a number of data points to a series.
        /// </summary>
        private static void applyDataPoints(ChartSeries series, int dataPointsCount, int markerSymbol, int dataPointSize) {
            for (int i = 0; i < dataPointsCount; i++) {
                ChartDataPoint point = series.getDataPoints().get(i);
                point.getMarker().setSymbol(markerSymbol);
                point.getMarker().setSize(dataPointSize);
        
                Assert.assertEquals(point.getIndex(), i);
            }
        }
      • get

        public ChartDataPoint get(int index)
        
        Returns ChartDataPoint for the specified index.

        Example:

        Shows how to work with data points on a line chart.
        @Test
        public void chartDataPoint() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            Shape shape = builder.insertChart(ChartType.LINE, 500.0, 350.0);
            Chart chart = shape.getChart();
        
            Assert.assertEquals(3, chart.getSeries().getCount());
            Assert.assertEquals("Series 1", chart.getSeries().get(0).getName());
            Assert.assertEquals("Series 2", chart.getSeries().get(1).getName());
            Assert.assertEquals("Series 3", chart.getSeries().get(2).getName());
        
            // Emphasize the chart's data points by making them appear as diamond shapes.
            for (ChartSeries series : chart.getSeries())
                applyDataPoints(series, 4, MarkerSymbol.DIAMOND, 15);
        
            // Smooth out the line that represents the first data series.
            chart.getSeries().get(0).setSmooth(true);
        
            // Verify that data points for the first series will not invert their colors if the value is negative.
            Iterator<ChartDataPoint> enumerator = chart.getSeries().get(0).getDataPoints().iterator();
            while (enumerator.hasNext()) {
                Assert.assertFalse(enumerator.next().getInvertIfNegative());
            }
        
            // For a cleaner looking graph, we can clear format individually.
            chart.getSeries().get(1).getDataPoints().get(2).clearFormat();
        
            // We can also strip an entire series of data points at once.
            chart.getSeries().get(2).getDataPoints().clearFormat();
        
            doc.save(getArtifactsDir() + "Charts.ChartDataPoint.docx");
        }
        
        /// <summary>
        /// Applies a number of data points to a series.
        /// </summary>
        private static void applyDataPoints(ChartSeries series, int dataPointsCount, int markerSymbol, int dataPointSize) {
            for (int i = 0; i < dataPointsCount; i++) {
                ChartDataPoint point = series.getDataPoints().get(i);
                point.getMarker().setSymbol(markerSymbol);
                point.getMarker().setSize(dataPointSize);
        
                Assert.assertEquals(point.getIndex(), i);
            }
        }
    • Method Detail

      • add

        @Deprecated
        public ChartDataPoint add(int index)
        Deprecated. Adds new ChartDataPoint at the specified index.
        Parameters:
        index - Target data point index.
      • clear

        @Deprecated
        public void clear()
        Deprecated. Clears format of all ChartDataPoint in this collection.
      • clearFormat

        public void clearFormat()
        Clears format of all ChartDataPoint in this collection.

        Example:

        Shows how to work with data points on a line chart.
        @Test
        public void chartDataPoint() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            Shape shape = builder.insertChart(ChartType.LINE, 500.0, 350.0);
            Chart chart = shape.getChart();
        
            Assert.assertEquals(3, chart.getSeries().getCount());
            Assert.assertEquals("Series 1", chart.getSeries().get(0).getName());
            Assert.assertEquals("Series 2", chart.getSeries().get(1).getName());
            Assert.assertEquals("Series 3", chart.getSeries().get(2).getName());
        
            // Emphasize the chart's data points by making them appear as diamond shapes.
            for (ChartSeries series : chart.getSeries())
                applyDataPoints(series, 4, MarkerSymbol.DIAMOND, 15);
        
            // Smooth out the line that represents the first data series.
            chart.getSeries().get(0).setSmooth(true);
        
            // Verify that data points for the first series will not invert their colors if the value is negative.
            Iterator<ChartDataPoint> enumerator = chart.getSeries().get(0).getDataPoints().iterator();
            while (enumerator.hasNext()) {
                Assert.assertFalse(enumerator.next().getInvertIfNegative());
            }
        
            // For a cleaner looking graph, we can clear format individually.
            chart.getSeries().get(1).getDataPoints().get(2).clearFormat();
        
            // We can also strip an entire series of data points at once.
            chart.getSeries().get(2).getDataPoints().clearFormat();
        
            doc.save(getArtifactsDir() + "Charts.ChartDataPoint.docx");
        }
        
        /// <summary>
        /// Applies a number of data points to a series.
        /// </summary>
        private static void applyDataPoints(ChartSeries series, int dataPointsCount, int markerSymbol, int dataPointSize) {
            for (int i = 0; i < dataPointsCount; i++) {
                ChartDataPoint point = series.getDataPoints().get(i);
                point.getMarker().setSymbol(markerSymbol);
                point.getMarker().setSize(dataPointSize);
        
                Assert.assertEquals(point.getIndex(), i);
            }
        }
      • iterator

        public java.util.Iterator<ChartDataPoint> iterator()
        Returns an enumerator object.

        Example:

        Shows how to work with data points on a line chart.
        @Test
        public void chartDataPoint() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            Shape shape = builder.insertChart(ChartType.LINE, 500.0, 350.0);
            Chart chart = shape.getChart();
        
            Assert.assertEquals(3, chart.getSeries().getCount());
            Assert.assertEquals("Series 1", chart.getSeries().get(0).getName());
            Assert.assertEquals("Series 2", chart.getSeries().get(1).getName());
            Assert.assertEquals("Series 3", chart.getSeries().get(2).getName());
        
            // Emphasize the chart's data points by making them appear as diamond shapes.
            for (ChartSeries series : chart.getSeries())
                applyDataPoints(series, 4, MarkerSymbol.DIAMOND, 15);
        
            // Smooth out the line that represents the first data series.
            chart.getSeries().get(0).setSmooth(true);
        
            // Verify that data points for the first series will not invert their colors if the value is negative.
            Iterator<ChartDataPoint> enumerator = chart.getSeries().get(0).getDataPoints().iterator();
            while (enumerator.hasNext()) {
                Assert.assertFalse(enumerator.next().getInvertIfNegative());
            }
        
            // For a cleaner looking graph, we can clear format individually.
            chart.getSeries().get(1).getDataPoints().get(2).clearFormat();
        
            // We can also strip an entire series of data points at once.
            chart.getSeries().get(2).getDataPoints().clearFormat();
        
            doc.save(getArtifactsDir() + "Charts.ChartDataPoint.docx");
        }
        
        /// <summary>
        /// Applies a number of data points to a series.
        /// </summary>
        private static void applyDataPoints(ChartSeries series, int dataPointsCount, int markerSymbol, int dataPointSize) {
            for (int i = 0; i < dataPointsCount; i++) {
                ChartDataPoint point = series.getDataPoints().get(i);
                point.getMarker().setSymbol(markerSymbol);
                point.getMarker().setSize(dataPointSize);
        
                Assert.assertEquals(point.getIndex(), i);
            }
        }
      • removeAt

        @Deprecated
        public void removeAt(int index)
        Deprecated. Clears format of a ChartDataPoint at the specified index.
        Parameters:
        index - The zero-based index of the data point to clear format.