Edit

Share via

Excel.Interfaces.ChartTrendlineLoadOptions interface

  • Reference
Package:
excel

This object represents the attributes for a chart trendline object.

Remarks

[ API set: ExcelApi 1.7 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
backwardPeriod

Represents the number of periods that the trendline extends backward.
format

Represents the formatting of a chart trendline.
forwardPeriod

Represents the number of periods that the trendline extends forward.
intercept

Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number.
label

Represents the label of a chart trendline.
movingAveragePeriod

Represents the period of a chart trendline. Only applicable to trendlines with the type MovingAverage.
name

Represents the name of the trendline. Can be set to a string value, a null value represents automatic values. The returned value is always a string
polynomialOrder

Represents the order of a chart trendline. Only applicable to trendlines with the type Polynomial.
showEquation

True if the equation for the trendline is displayed on the chart.
showRSquared

True if the r-squared value for the trendline is displayed on the chart.
type

Represents the type of a chart trendline.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

backwardPeriod

Represents the number of periods that the trendline extends backward.

backwardPeriod?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

format

Represents the formatting of a chart trendline.

format?: Excel.Interfaces.ChartTrendlineFormatLoadOptions;

Property Value

Excel.Interfaces.ChartTrendlineFormatLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

forwardPeriod

Represents the number of periods that the trendline extends forward.

forwardPeriod?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

intercept

Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number.

intercept?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

label

Represents the label of a chart trendline.

label?: Excel.Interfaces.ChartTrendlineLabelLoadOptions;

Property Value

Excel.Interfaces.ChartTrendlineLabelLoadOptions

Remarks

[ API set: ExcelApi 1.8 ]

movingAveragePeriod

Represents the period of a chart trendline. Only applicable to trendlines with the type MovingAverage.

movingAveragePeriod?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

name

Represents the name of the trendline. Can be set to a string value, a null value represents automatic values. The returned value is always a string

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

polynomialOrder

Represents the order of a chart trendline. Only applicable to trendlines with the type Polynomial.

polynomialOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showEquation

True if the equation for the trendline is displayed on the chart.

showEquation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showRSquared

True if the r-squared value for the trendline is displayed on the chart.

showRSquared?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

type

Represents the type of a chart trendline.

type?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]