[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

ITrendlines

Interface ITrendlines

All Superinterfaces:
Iterable<ITrendline>
public interface ITrendlines extends Iterable<ITrendline>
Represents the collection of trend lines for a specific chart ISeries.

Use this interface to add, access, and iterate the ITrendline objects associated with a series. A trendline can be used to show the data trend for the series and can then be configured through the returned ITrendline object.


 worksheet.getRange("A1:B5").setValue(new Object[][] {
     {"Item", "Sales"}, {"Jan", 10}, {"Feb", 15}, {"Mar", 18}, {"Apr", 24}
 });
 IShape shape = worksheet.getShapes().addChart(ChartType.ColumnClustered, 200, 30, 300, 300);
 shape.getChart().getSeriesCollection().add(worksheet.getRange("A1:B5"), RowCol.Columns, true, true);
 ISeries series = shape.getChart().getSeriesCollection().get(0);
 ITrendlines trendlines = series.getTrendlines();
 ITrendline trendline = trendlines.add();
 trendline.setType(TrendlineType.Linear);

  • Method Details

    • getCount

      int getCount()
      Gets the number of ITrendline objects in this collection.

      Use this method to determine how many trendlines are currently associated with the parent series.

      
 worksheet.getRange("A1:B4").setValue(new Object[][] {
     {"Month", "Sales"},
     {"Jan", 10},
     {"Feb", 12},
     {"Mar", 15}
 });
 IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
 chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, false);
 ITrendlines trendlines = chart.getSeriesCollection().get(0).getTrendlines();
 trendlines.add();
 int count = trendlines.getCount();
      Returns:
      The number of trendlines in this collection.

    • getParent

      ISeries getParent()
      Gets the ISeries object that owns this trendline collection.

      Use this method to access the parent series after obtaining an ITrendlines collection from a chart series.

      
 worksheet.getRange("A1:B4").setValue(new Object[][] {
     {"Month", "Sales"},
     {"Jan", 12},
     {"Feb", 18},
     {"Mar", 15}
 });
 IShape shape = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200);
 IChart chart = shape.getChart();
 chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, false);
 ITrendlines trendlines = chart.getSeriesCollection().get(0).getTrendlines();
 trendlines.add();
 ISeries parentSeries = trendlines.getParent();
      Returns:
      The parent ISeries object for this trendline collection.

    • add

      ITrendline add()
      Creates a new trendline and adds it to this collection.

      Use this method to create a trendline for the parent series and then configure the returned ITrendline object.

      
 worksheet.getRange("A1:B4").setValue(new Object[][] {
     {"Month", "Sales"},
     {"Jan", 10},
     {"Feb", 12},
     {"Mar", 15}
 });
 IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
 chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, false);
 ITrendline trendline = chart.getSeriesCollection().get(0).getTrendlines().add();
 trendline.setType(TrendlineType.Linear);
      Returns:
      The created ITrendline object.

    • get

      ITrendline get(int index)
      Gets the ITrendline object at the specified index in this collection.

      Use this method to access an existing trendline that belongs to a chart series.

      
 worksheet.getRange("A1:B4").setValue(new Object[][] {
     {"Month", "Sales"},
     {"Jan", 10},
     {"Feb", 12},
     {"Mar", 15}
 });
 IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
 chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, false);
 ITrendlines trendlines = chart.getSeriesCollection().get(0).getTrendlines();
 trendlines.add();
 ITrendline trendline = trendlines.get(0);
      Parameters:
      index - The index of the trendline to return.
      Returns:
      The ITrendline object at the specified index.