com.aspose.cells
Class Trendline

java.lang.Object
  extended by Line
      extended by com.aspose.cells.Trendline

public class Trendline 
extends Line

Represents a trendline in a chart.

Example:

//Instantiating a Workbook object
Workbook workbook = new Workbook();
//Adding a new worksheet to the Excel object
int sheetIndex = workbook.getWorksheets().add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.getCells().get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.getCells().get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.getCells().get("A3").putValue(150);
//Adding a sample value to "A4" cell
worksheet.getCells().get("A4").putValue(200);
//Adding a sample value to "B1" cell
worksheet.getCells().get("B1").putValue(60);
//Adding a sample value to "B2" cell
worksheet.getCells().get("B2").putValue(32);
//Adding a sample value to "B3" cell
worksheet.getCells().get("B3").putValue(50);
//Adding a sample value to "B4" cell
worksheet.getCells().get("B4").putValue(40);
//Adding a sample value to "C1" cell as category data
worksheet.getCells().get("C1").putValue("Q1");
//Adding a sample value to "C2" cell as category data
worksheet.getCells().get("C2").putValue("Q2");
//Adding a sample value to "C3" cell as category data
worksheet.getCells().get("C3").putValue("Y1");
//Adding a sample value to "C4" cell as category data
worksheet.getCells().get("C4").putValue("Y2");
//Adding a chart to the worksheet
int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
Chart chart = worksheet.getCharts().get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
chart.getNSeries().add("A1:B4", true);
//Setting the data source for the category data of NSeries
chart.getNSeries().setCategoryData("C1:C4");
//adding a linear trendline
int index = chart.getNSeries().get(0).getTrendLines().add(TrendlineType.LINEAR);
Trendline trendline = chart.getNSeries().get(0).getTrendLines().get(index);
//Setting the custom name of the trendline.
trendline.setName("Linear");
//Displaying the equation on chart
trendline.setDisplayEquation(true);
//Displaying the R-Squared value on chart
trendline.setDisplayRSquared(true);
//Saving the Excel file
workbook.save("C:\\book1.xls");

Property Getters/Setters Summary
doublegetBackward()
voidsetBackward(double value)
           Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than and equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5
com.aspose.cells.ColorgetColor()→ inherited from Line
voidsetColor(com.aspose.cells.Color value)
           Represents the com.aspose.cells.Color of the line.
DataLabelsgetDataLabels()
           Represents the DataLabels object for the specified ASeries.
booleangetDisplayEquation()
voidsetDisplayEquation(boolean value)
           Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.
booleangetDisplayRSquared()
voidsetDisplayRSquared(boolean value)
           Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.
doublegetForward()
voidsetForward(double value)
           Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than and equal to zero.
GradientFillgetGradientFill()→ inherited from Line
           Represents gradient fill.
doublegetIntercept()
voidsetIntercept(double value)
           Returns or sets the point where the trendline crosses the value axis.
booleanisAuto()→ inherited from Line
voidsetAuto(boolean value)
           Indicates whether this line style is auto assigned.
booleanisAutomaticColor()→ inherited from Line
           Indicates whether the color of line is auotmatic assigned.
booleanisNameAuto()
voidsetNameAuto(boolean value)
           Returns if Microsoft Excel automatically determines the name of the trendline.
booleanisVisible()→ inherited from Line
voidsetVisible(boolean value)
           Represents whether the line is visible.
LegendEntrygetLegendEntry()
           Gets the legend entry according to this trendline
java.lang.StringgetName()
voidsetName(java.lang.String value)
           Returns the name of the trendline.
intgetOrder()
voidsetOrder(int value)
           Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.
intgetPeriod()
voidsetPeriod(int value)
           Returns or sets the period for the moving-average trendline.
intgetStyle()→ inherited from Line
voidsetStyle(int value)
           Represents the style of the line. The value of the property is LineType integer constant.
doublegetTransparency()→ inherited from Line
voidsetTransparency(double value)
           Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
intgetType()
           Returns the trendline type. The value of the property is TrendlineType integer constant.
intgetWeight()→ inherited from Line
voidsetWeight(int value)
           Gets or sets the WeightType of the line. The value of the property is WeightType integer constant.
doublegetWeightPt()→ inherited from Line
voidsetWeightPt(double value)
           Gets or sets the weight of the line in unit of points. Only applies for Excel 2007 file.
 
Method Summary
booleanisInterceptAuto()
           Indicates whether Microsoft Workbook automatically determines the intercept of the trendline.
voidsetInterceptAuto(boolean isInterceptAuto)
           Sets whether Microsoft Workbook automatically determines the intercept of the trendline.
 

Property Getters/Setters Detail

isNameAuto/setNameAuto

public boolean isNameAuto() / public void setNameAuto(boolean value)
Returns if Microsoft Excel automatically determines the name of the trendline.

getType

public int getType()
Returns the trendline type. The value of the property is TrendlineType integer constant.

getName/setName

public java.lang.String getName() / public void setName(java.lang.String value)
Returns the name of the trendline.

getOrder/setOrder

public int getOrder() / public void setOrder(int value)
Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.

getPeriod/setPeriod

public int getPeriod() / public void setPeriod(int value)
Returns or sets the period for the moving-average trendline. This value should be between 2 and 255. And it must be less than the number of the chart points in the series

getForward/setForward

public double getForward() / public void setForward(double value)
Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than and equal to zero.

getBackward/setBackward

public double getBackward() / public void setBackward(double value)
Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than and equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5

getDisplayEquation/setDisplayEquation

public boolean getDisplayEquation() / public void setDisplayEquation(boolean value)
Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.

getDisplayRSquared/setDisplayRSquared

public boolean getDisplayRSquared() / public void setDisplayRSquared(boolean value)
Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.

getIntercept/setIntercept

public double getIntercept() / public void setIntercept(double value)
Returns or sets the point where the trendline crosses the value axis.

getDataLabels

public DataLabels getDataLabels()
Represents the DataLabels object for the specified ASeries.

getLegendEntry

public LegendEntry getLegendEntry()
Gets the legend entry according to this trendline

getColor/setColor

→ inherited from Line
public com.aspose.cells.Color getColor() / public void setColor(com.aspose.cells.Color value)
Represents the com.aspose.cells.Color of the line.

getTransparency/setTransparency

→ inherited from Line
public double getTransparency() / public void setTransparency(double value)
Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).

getStyle/setStyle

→ inherited from Line
public int getStyle() / public void setStyle(int value)
Represents the style of the line. The value of the property is LineType integer constant.

getWeight/setWeight

→ inherited from Line
public int getWeight() / public void setWeight(int value)
Gets or sets the WeightType of the line. The value of the property is WeightType integer constant.

getWeightPt/setWeightPt

→ inherited from Line
public double getWeightPt() / public void setWeightPt(double value)
Gets or sets the weight of the line in unit of points. Only applies for Excel 2007 file.

isAutomaticColor

→ inherited from Line
public boolean isAutomaticColor()
Indicates whether the color of line is auotmatic assigned.

isVisible/setVisible

→ inherited from Line
public boolean isVisible() / public void setVisible(boolean value)
Represents whether the line is visible.

isAuto/setAuto

→ inherited from Line
public boolean isAuto() / public void setAuto(boolean value)
Indicates whether this line style is auto assigned.

getGradientFill

→ inherited from Line
public GradientFill getGradientFill()
Represents gradient fill.

Method Detail

isInterceptAuto

public boolean isInterceptAuto()
Indicates whether Microsoft Workbook automatically determines the intercept of the trendline.

setInterceptAuto

public void setInterceptAuto(boolean isInterceptAuto)
Sets whether Microsoft Workbook automatically determines the intercept of the trendline.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.