aspose.cells

Class Trendline

Represents a trendline in a chart.

Example:

//Instantiating a Workbook object
var workbook = new aspose.cells.Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.getWorksheets().add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var 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
var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
var 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
var index = chart.getNSeries().get(0).getTrendLines().add(aspose.cells.TrendlineType.LINEAR);
var 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("Book1.xls");

Property Getters/Setters Summary
functiongetBackward()
function
           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
functiongetBeginArrowLength()
function
           Specifies the length of the arrowhead for the begin of a line. The value of the property is MsoArrowheadLength integer constant.
functiongetBeginArrowWidth()
function
           Specifies the width of the arrowhead for the begin of a line. The value of the property is MsoArrowheadWidth integer constant.
functiongetBeginType()
function
           Specifies an arrowhead for the begin of a line. The value of the property is MsoArrowheadStyle integer constant.
functiongetCapType()
function
setCapType(value)
           Specifies the ending caps. The value of the property is LineCapType integer constant.
functiongetColor()
function
setColor(value)
           Represents the com.aspose.cells.Color of the line.
functiongetCompoundType()
function
           Specifies the compound line type The value of the property is MsoLineStyle integer constant.
functiongetDashType()
function
           Specifies the dash line type The value of the property is MsoLineDashStyle integer constant.
functiongetDataLabels()
Represents the DataLabels object for the specified ASeries.
functiongetDisplayEquation()
function
           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.
functiongetDisplayRSquared()
function
           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.
functiongetEndArrowLength()
function
           Specifies the length of the arrowhead for the end of a line. The value of the property is MsoArrowheadLength integer constant.
functiongetEndArrowWidth()
function
           Specifies the width of the arrowhead for the end of a line. The value of the property is MsoArrowheadWidth integer constant.
functiongetEndType()
function
setEndType(value)
           Specifies an arrowhead for the end of a line. The value of the property is MsoArrowheadStyle integer constant.
functiongetFormattingType()
function
           Gets or sets format type. The value of the property is ChartLineFormattingType integer constant.
functiongetForward()
function
setForward(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.
functiongetGradientFill()
Represents gradient fill.
functiongetIntercept()
function
           Returns or sets the point where the trendline crosses the value axis.
functionisAuto()
function
setAuto(value)
           Indicates whether this line style is auto assigned.
functionisAutomaticColor()
Indicates whether the color of line is auotmatic assigned.
functionisNameAuto()
function
           Returns if Microsoft Excel automatically determines the name of the trendline.
functionisVisible()
function
setVisible(value)
           Represents whether the line is visible.
functiongetJoinType()
function
           Specifies the joining caps. The value of the property is LineJoinType integer constant.
functiongetLegendEntry()
Gets the legend entry according to this trendline
functiongetName()
function
setName(value)
           Returns the name of the trendline.
functiongetOrder()
function
setOrder(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.
functiongetPeriod()
function
setPeriod(value)
           Returns or sets the period for the moving-average trendline.
functiongetStyle()
function
setStyle(value)
           Represents the style of the line. The value of the property is LineType integer constant.
functiongetThemeColor()
function
           Gets and sets the theme color.
functiongetTransparency()
function
           Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
functiongetType()
Returns the trendline type. The value of the property is TrendlineType integer constant.
functiongetWeight()
function
setWeight(value)
           Gets or sets the WeightType of the line. The value of the property is WeightType integer constant.
functiongetWeightPt()
function
           Gets or sets the weight of the line in unit of points.
functiongetWeightPx()
function
           Gets or sets the weight of the line in uni of pixels.
 
Method Summary
functionisInterceptAuto()
Indicates whether Microsoft Workbook automatically determines the intercept of the trendline.
functionsetInterceptAuto(isInterceptAuto)
Sets whether Microsoft Workbook automatically determines the intercept of the trendline.
 

    • Property Getters/Setters Detail

      • isNameAuto/setNameAuto : boolean 

        function isNameAuto() / function setNameAuto(value)
        
        Returns if Microsoft Excel automatically determines the name of the trendline.
      • getType : Number 

        function getType()
        
        Returns the trendline type. The value of the property is TrendlineType integer constant.
      • getName/setName : String 

        function getName() / function setName(value)
        
        Returns the name of the trendline.
      • getOrder/setOrder : Number 

        function getOrder() / function setOrder(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 : Number 

        function getPeriod() / function setPeriod(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 : Number 

        function getForward() / function setForward(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 : Number 

        function getBackward() / function setBackward(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 : boolean 

        function getDisplayEquation() / function setDisplayEquation(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 : boolean 

        function getDisplayRSquared() / function setDisplayRSquared(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 : Number 

        function getIntercept() / function setIntercept(value)
        
        Returns or sets the point where the trendline crosses the value axis.
      • getDataLabels : DataLabels 

        function getDataLabels()
        
        Represents the DataLabels object for the specified ASeries.
      • getLegendEntry : LegendEntry 

        function getLegendEntry()
        
        Gets the legend entry according to this trendline
      • getCompoundType/setCompoundType : Number 

        function getCompoundType() / function setCompoundType(value)
        
        Specifies the compound line type The value of the property is MsoLineStyle integer constant.
      • getDashType/setDashType : Number 

        function getDashType() / function setDashType(value)
        
        Specifies the dash line type The value of the property is MsoLineDashStyle integer constant.
      • getCapType/setCapType : Number 

        function getCapType() / function setCapType(value)
        
        Specifies the ending caps. The value of the property is LineCapType integer constant.
      • getJoinType/setJoinType : Number 

        function getJoinType() / function setJoinType(value)
        
        Specifies the joining caps. The value of the property is LineJoinType integer constant.
      • getBeginType/setBeginType : Number 

        function getBeginType() / function setBeginType(value)
        
        Specifies an arrowhead for the begin of a line. The value of the property is MsoArrowheadStyle integer constant.
      • getEndType/setEndType : Number 

        function getEndType() / function setEndType(value)
        
        Specifies an arrowhead for the end of a line. The value of the property is MsoArrowheadStyle integer constant.
      • getBeginArrowLength/setBeginArrowLength : Number 

        function getBeginArrowLength() / function setBeginArrowLength(value)
        
        Specifies the length of the arrowhead for the begin of a line. The value of the property is MsoArrowheadLength integer constant.
      • getEndArrowLength/setEndArrowLength : Number 

        function getEndArrowLength() / function setEndArrowLength(value)
        
        Specifies the length of the arrowhead for the end of a line. The value of the property is MsoArrowheadLength integer constant.
      • getBeginArrowWidth/setBeginArrowWidth : Number 

        function getBeginArrowWidth() / function setBeginArrowWidth(value)
        
        Specifies the width of the arrowhead for the begin of a line. The value of the property is MsoArrowheadWidth integer constant.
      • getEndArrowWidth/setEndArrowWidth : Number 

        function getEndArrowWidth() / function setEndArrowWidth(value)
        
        Specifies the width of the arrowhead for the end of a line. The value of the property is MsoArrowheadWidth integer constant.
      • getThemeColor/setThemeColor : ThemeColor 

        function getThemeColor() / function setThemeColor(value)
        
        Gets and sets the theme color. If the forground color is not a theme color, NULL will be returned.
      • getColor/setColor : Color 

        function getColor() / function setColor(value)
        
        Represents the com.aspose.cells.Color of the line.
      • getTransparency/setTransparency : Number 

        function getTransparency() / function setTransparency(value)
        
        Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
      • getStyle/setStyle : Number 

        function getStyle() / function setStyle(value)
        
        Represents the style of the line. The value of the property is LineType integer constant.
      • getWeight/setWeight : Number 

        function getWeight() / function setWeight(value)
        
        Gets or sets the WeightType of the line. The value of the property is WeightType integer constant.
      • getWeightPt/setWeightPt : Number 

        function getWeightPt() / function setWeightPt(value)
        
        Gets or sets the weight of the line in unit of points.
      • getWeightPx/setWeightPx : Number 

        function getWeightPx() / function setWeightPx(value)
        
        Gets or sets the weight of the line in uni of pixels.
      • getFormattingType/setFormattingType : Number 

        function getFormattingType() / function setFormattingType(value)
        
        Gets or sets format type. The value of the property is ChartLineFormattingType integer constant.
      • isAutomaticColor : boolean 

        function isAutomaticColor()
        
        Indicates whether the color of line is auotmatic assigned.
      • isVisible/setVisible : boolean 

        function isVisible() / function setVisible(value)
        
        Represents whether the line is visible.
      • isAuto/setAuto : boolean 

        function isAuto() / function setAuto(value)
        
        Indicates whether this line style is auto assigned.
      • getGradientFill : GradientFill 

        function getGradientFill()
        
        Represents gradient fill.
    • Method Detail

      • isInterceptAuto

        function isInterceptAuto()
        Indicates whether Microsoft Workbook automatically determines the intercept of the trendline.
      • setInterceptAuto

        function setInterceptAuto(isInterceptAuto)
        Sets whether Microsoft Workbook automatically determines the intercept of the trendline.