Edit

Share via


Excel.Interfaces.ChartTrendlineData interface

An interface describing the data returned by calling chartTrendline.toJSON().

Properties

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

backwardPeriod

Represents the number of periods that the trendline extends backward.

TypeScript
backwardPeriod?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

format

Represents the formatting of a chart trendline.

TypeScript
format?: Excel.Interfaces.ChartTrendlineFormatData;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

forwardPeriod

Represents the number of periods that the trendline extends forward.

TypeScript
forwardPeriod?: number;

Property Value

number

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.

TypeScript
intercept?: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.7 ]

label

Represents the label of a chart trendline.

TypeScript
label?: Excel.Interfaces.ChartTrendlineLabelData;

Property Value

Remarks

[ API set: ExcelApi 1.8 ]

movingAveragePeriod

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

TypeScript
movingAveragePeriod?: number;

Property Value

number

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

TypeScript
name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

polynomialOrder

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

TypeScript
polynomialOrder?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

showEquation

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

TypeScript
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.

TypeScript
showRSquared?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

type

Represents the type of a chart trendline.

TypeScript
type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power";

Property Value

Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"

Remarks

[ API set: ExcelApi 1.7 ]