com.aspose.slides
Class Trendline

java.lang.Object
  extended by com.aspose.slides.Trendline
All Implemented Interfaces:
IChartComponent, IFormattedTextContainer, IOverridableText, ITrendline

public class Trendline
extends java.lang.Object
implements ITrendline

Class represents trend line of chart series


Method Summary
 ITextFrame addTextFrameForOverriding(java.lang.String text)
           Initialize TextFrameForOverriding with the text in paramener "text".
 double getBackward()
           Specifies the number of categories (or units on a scatter chart) that the trend line extends before the data for the series that is being trended.
 IChart getChart()
           Returns the parent chart.
 boolean getDisplayEquation()
           Specifies that the equation for the trendline is displayed on the chart (in the same label as the Rsquaredvalue).
 boolean getDisplayRSquaredValue()
           Specifies that the R-squared value of the trendline is displayed on the chart (in the same label as the equation).
 IFormat getFormat()
           Represents the format of the trend line.
 double getForward()
           Specifies the number of categories (or units on a scatter chart) that the trendline extends after the data for the series that is being trended.
 double getIntercept()
           Specifies the value where the trendline shall cross the y axis.
 byte getOrder()
           Specifies the order of the polynomial trend line.
 byte getPeriod()
           Specifies the period of the trend line for a moving average trend line.
 IChartTextFormat getTextFormat()
           
 TextFrame getTextFrame()
          Deprecated. 
 ITextFrame getTextFrameForOverriding()
           Can contain a rich formatted text.
 java.lang.String getTrendlineName()
           Gets or sets name of the trendline
 int getTrendlineType()
           Gets or sets type of trend line.
 void setBackward(double value)
           
 void setDisplayEquation(boolean value)
           
 void setDisplayRSquaredValue(boolean value)
           
 void setFormat(IFormat value)
           
 void setForward(double value)
           
 void setIntercept(double value)
           
 void setOrder(byte value)
           
 void setPeriod(byte value)
           
 void setTextFrame(TextFrame value)
          Deprecated. 
 void setTrendlineName(java.lang.String value)
           
 void setTrendlineType(int value)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getTrendlineName

public java.lang.String getTrendlineName()

Gets or sets name of the trendline

Specified by:
getTrendlineName in interface ITrendline

setTrendlineName

public void setTrendlineName(java.lang.String value)
Specified by:
setTrendlineName in interface ITrendline

getTrendlineType

public int getTrendlineType()

Gets or sets type of trend line.

Specified by:
getTrendlineType in interface ITrendline

setTrendlineType

public void setTrendlineType(int value)
Specified by:
setTrendlineType in interface ITrendline

getTextFrame

@Deprecated
public TextFrame getTextFrame()
Deprecated. 

Returns a text frame of the trend line.


setTextFrame

@Deprecated
public void setTextFrame(TextFrame value)
Deprecated. 


getFormat

public IFormat getFormat()

Represents the format of the trend line. Read/write Charts.Format.

Specified by:
getFormat in interface ITrendline

setFormat

public void setFormat(IFormat value)
Specified by:
setFormat in interface ITrendline

getBackward

public double getBackward()

Specifies the number of categories (or units on a scatter chart) that the trend line extends before the data for the series that is being trended. On scatter and non-scatter charts, the value shall be any nonnegative value.

Specified by:
getBackward in interface ITrendline

setBackward

public void setBackward(double value)
Specified by:
setBackward in interface ITrendline

getForward

public double getForward()

Specifies the number of categories (or units on a scatter chart) that the trendline extends after the data for the series that is being trended. On scatter and non-scatter charts, the value shall be any non-negative value.

Specified by:
getForward in interface ITrendline

setForward

public void setForward(double value)
Specified by:
setForward in interface ITrendline

getIntercept

public double getIntercept()

Specifies the value where the trendline shall cross the y axis. This property shall be supported only when the trendline type is exp, linear, or poly.

Specified by:
getIntercept in interface ITrendline

setIntercept

public void setIntercept(double value)
Specified by:
setIntercept in interface ITrendline

getDisplayEquation

public boolean getDisplayEquation()

Specifies that the equation for the trendline is displayed on the chart (in the same label as the Rsquaredvalue).

Specified by:
getDisplayEquation in interface ITrendline

setDisplayEquation

public void setDisplayEquation(boolean value)
Specified by:
setDisplayEquation in interface ITrendline

getOrder

public byte getOrder()

Specifies the order of the polynomial trend line. It is ignored for other trend line types. Value must be between 2 and 6.

Specified by:
getOrder in interface ITrendline

setOrder

public void setOrder(byte value)
Specified by:
setOrder in interface ITrendline

getPeriod

public byte getPeriod()

Specifies the period of the trend line for a moving average trend line. It is ignored for other trend line variants. Value must be between 2 and 255.

Specified by:
getPeriod in interface ITrendline

setPeriod

public void setPeriod(byte value)
Specified by:
setPeriod in interface ITrendline

getDisplayRSquaredValue

public boolean getDisplayRSquaredValue()

Specifies that the R-squared value of the trendline is displayed on the chart (in the same label as the equation).

Specified by:
getDisplayRSquaredValue in interface ITrendline

setDisplayRSquaredValue

public void setDisplayRSquaredValue(boolean value)
Specified by:
setDisplayRSquaredValue in interface ITrendline

addTextFrameForOverriding

public ITextFrame addTextFrameForOverriding(java.lang.String text)

Initialize TextFrameForOverriding with the text in paramener "text". If TextFrameForOverriding is already initialized then simply changes its text.

Specified by:
addTextFrameForOverriding in interface IOverridableText
Parameters:
text - Text for a new TextFrameForOverriding.

getTextFrameForOverriding

public ITextFrame getTextFrameForOverriding()

Can contain a rich formatted text. If this property is not null then this formatted text value overrides auto-generated text of data label. Auto-generated text of data label means text that is managed by ShowSeriesName, ShowValue, ... properties and is formatted with the TextFormatManager.TextFormat property.

Specified by:
getTextFrameForOverriding in interface IOverridableText

getTextFormat

public IChartTextFormat getTextFormat()
Specified by:
getTextFormat in interface IFormattedTextContainer

getChart

public IChart getChart()

Returns the parent chart. Read-only IChart.

Specified by:
getChart in interface IChartComponent