com.aspose.slides

Class Trendline

java.lang.Object

com.aspose.slides.DomObject<TrendlineCollection>

com.aspose.slides.Trendline

All Implemented Interfaces:

IChartComponent, IFormattedTextContainer, IOverridableText, IPresentationComponent, ISlideComponent, ITrendline

public class Trendline
extends DomObject<TrendlineCollection>
implements ITrendline

Class represents trend line of chart series

Method Summary

Modifier and Type	Method and Description
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.
IPresentation	getPresentation() Returns the parent presentation of a FillFormat.
ILegendEntryProperties	getRelatedLegendEntry() Represents legend entry related with this trendline Read-only ILegendEntryProperties.
IBaseSlide	getSlide() Returns the parent slide of a FillFormat.
IChartTextFormat	getTextFormat() Returns text format.
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) 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.
void	setDisplayEquation(boolean value) Specifies that the equation for the trendline is displayed on the chart (in the same label as the Rsquaredvalue).
void	setDisplayRSquaredValue(boolean value) Specifies that the R-squared value of the trendline is displayed on the chart (in the same label as the equation).
void	setFormat(IFormat value) Represents the format of the trend line.
void	setForward(double value) 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.
void	setIntercept(double value) Specifies the value where the trendline shall cross the y axis.
void	setOrder(byte value) Specifies the order of the polynomial trend line.
void	setPeriod(byte value) Specifies the period of the trend line for a moving average trend line.
void	setTrendlineName(java.lang.String value) Gets or sets name of the trendline.
void	setTrendlineType(int value) Gets or sets type of trend line.

Methods inherited from class com.aspose.slides.DomObject

getParent_Immediate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTrendlineName

public final java.lang.String getTrendlineName()

Gets or sets name of the trendline. Read/write String.

Specified by:

getTrendlineName in interface ITrendline

setTrendlineName

public final void setTrendlineName(java.lang.String value)

Gets or sets name of the trendline. Read/write String.

Specified by:

setTrendlineName in interface ITrendline

getTrendlineType

public final int getTrendlineType()

Gets or sets type of trend line. Read/write TrendlineType.

Specified by:

getTrendlineType in interface ITrendline

setTrendlineType

public final void setTrendlineType(int value)

Gets or sets type of trend line. Read/write TrendlineType.

Specified by:

setTrendlineType in interface ITrendline

getFormat

public final IFormat getFormat()

Represents the format of the trend line. Read/write IFormat.

Specified by:

getFormat in interface ITrendline

setFormat

public final void setFormat(IFormat value)

Represents the format of the trend line. Read/write IFormat.

Specified by:

setFormat in interface ITrendline

getBackward

public final 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. Read/write double.

Specified by:

getBackward in interface ITrendline

setBackward

public final void setBackward(double value)

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. Read/write double.

Specified by:

setBackward in interface ITrendline

getForward

public final 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. Read/write double.

Specified by:

getForward in interface ITrendline

setForward

public final void setForward(double value)

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. Read/write double.

Specified by:

setForward in interface ITrendline

getIntercept

public final 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. Read/write double.

Specified by:

getIntercept in interface ITrendline

setIntercept

public final void setIntercept(double value)

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. Read/write double.

Specified by:

setIntercept in interface ITrendline

getDisplayEquation

public final boolean getDisplayEquation()

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

Specified by:

getDisplayEquation in interface ITrendline

setDisplayEquation

public final void setDisplayEquation(boolean value)

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

Specified by:

setDisplayEquation in interface ITrendline

getOrder

public final 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. Read/write byte.

Specified by:

getOrder in interface ITrendline

setOrder

public final void setOrder(byte value)

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

Specified by:

setOrder in interface ITrendline

getPeriod

public final 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. Read/write byte.

Specified by:

getPeriod in interface ITrendline

setPeriod

public final void setPeriod(byte value)

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. Read/write byte.

Specified by:

setPeriod in interface ITrendline

getDisplayRSquaredValue

public final boolean getDisplayRSquaredValue()

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

Specified by:

getDisplayRSquaredValue in interface ITrendline

setDisplayRSquaredValue

public final void setDisplayRSquaredValue(boolean value)

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

Specified by:

setDisplayRSquaredValue in interface ITrendline

getRelatedLegendEntry

public final ILegendEntryProperties getRelatedLegendEntry()

Represents legend entry related with this trendline Read-only ILegendEntryProperties.

Specified by:

getRelatedLegendEntry in interface ITrendline

addTextFrameForOverriding

public final 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.

Returns:

Text frame ITextFrame

getTextFrameForOverriding

public final 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. Read-only ITextFrame.

Specified by:

getTextFrameForOverriding in interface IOverridableText

getTextFormat

public final IChartTextFormat getTextFormat()

Returns text format. Read-only IChartTextFormat.

Specified by:

getTextFormat in interface IFormattedTextContainer

getChart

public final IChart getChart()

Returns the parent chart. Read-only IChart.

Specified by:

getChart in interface IChartComponent

getSlide

public final IBaseSlide getSlide()

Returns the parent slide of a FillFormat. Read-only BaseSlide.

Specified by:

getSlide in interface ISlideComponent

getPresentation

public final IPresentation getPresentation()

Returns the parent presentation of a FillFormat. Read-only IPresentation.

Specified by:

getPresentation in interface IPresentationComponent