Trendline

Inheritance: java.lang.Object, com.aspose.slides.DomObject

All Implemented Interfaces: com.aspose.slides.ITrendline

public class Trendline extends DomObject<TrendlineCollection> implements ITrendline

Class represents trend line of chart series

Methods

Method Description
getTrendlineName() Gets or sets name of the trendline.
setTrendlineName(String value) Gets or sets name of the trendline.
getTrendlineType() Gets or sets type of trend line.
setTrendlineType(int value) Gets or sets type of trend line.
getFormat() Represents the format of the trend line.
setFormat(IFormat value) Represents the format of the trend line.
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.
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.
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.
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.
getIntercept() Specifies the value where the trendline shall cross the y axis.
setIntercept(double value) Specifies the value where the trendline shall cross the y axis.
getDisplayEquation() Specifies that the equation for the trendline is displayed on the chart (in the same label as the Rsquaredvalue).
setDisplayEquation(boolean value) Specifies that the equation for the trendline is displayed on the chart (in the same label as the Rsquaredvalue).
getOrder() Specifies the order of the polynomial trend line.
setOrder(byte value) Specifies the order of the polynomial trend line.
getPeriod() Specifies the period of the trend line for a moving average trend line.
setPeriod(byte value) Specifies the period of the trend line for a moving average trend line.
getDisplayRSquaredValue() Specifies that the R-squared value of the trendline is displayed on the chart (in the same label as the equation).
setDisplayRSquaredValue(boolean value) Specifies that the R-squared value of the trendline is displayed on the chart (in the same label as the equation).
getRelatedLegendEntry() Represents legend entry related with this trendline Read-only ILegendEntryProperties.
addTextFrameForOverriding(String text) Initialize TextFrameForOverriding with the text in paramener “text”.
getTextFrameForOverriding() Can contain a rich formatted text.
getTextFormat() Returns text format.
getChart() Returns the parent chart.
getSlide() Returns the parent slide of a FillFormat.
getPresentation() Returns the parent presentation of a FillFormat.

getTrendlineName()

public final String getTrendlineName()

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

Returns: java.lang.String

setTrendlineName(String value)

public final void setTrendlineName(String value)

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

Parameters:

Parameter Type Description
value java.lang.String

getTrendlineType()

public final int getTrendlineType()

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

Returns: int

setTrendlineType(int value)

public final void setTrendlineType(int value)

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

Parameters:

Parameter Type Description
value int

getFormat()

public final IFormat getFormat()

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

Returns: IFormat

setFormat(IFormat value)

public final void setFormat(IFormat value)

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

Parameters:

Parameter Type Description
value IFormat

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.

Returns: double

setBackward(double value)

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.

Parameters:

Parameter Type Description
value double

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.

Returns: double

setForward(double value)

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.

Parameters:

Parameter Type Description
value double

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.

Returns: double

setIntercept(double value)

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.

Parameters:

Parameter Type Description
value double

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.

Returns: boolean

setDisplayEquation(boolean value)

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.

Parameters:

Parameter Type Description
value boolean

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.

Returns: byte

setOrder(byte value)

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.

Parameters:

Parameter Type Description
value byte

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.

Returns: byte

setPeriod(byte value)

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.

Parameters:

Parameter Type Description
value byte

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.

Returns: boolean

setDisplayRSquaredValue(boolean value)

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.

Parameters:

Parameter Type Description
value boolean

getRelatedLegendEntry()

public final ILegendEntryProperties getRelatedLegendEntry()

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

Returns: ILegendEntryProperties

addTextFrameForOverriding(String text)

public final ITextFrame addTextFrameForOverriding(String text)

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

Parameters:

Parameter Type Description
text java.lang.String Text for a new TextFrameForOverriding.

Returns: 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.

Returns: ITextFrame

getTextFormat()

public final IChartTextFormat getTextFormat()

Returns text format. Read-only IChartTextFormat.

Returns: IChartTextFormat

getChart()

public final IChart getChart()

Returns the parent chart. Read-only IChart.

Returns: IChart

getSlide()

public final IBaseSlide getSlide()

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

Returns: IBaseSlide

getPresentation()

public final IPresentation getPresentation()

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

Returns: IPresentation