Excel.ChartTrendline class
This object represents the attributes for a chart trendline object.
- Extends
Remarks
Properties
| backward |
Represents the number of periods that the trendline extends backward. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| format | Represents the formatting of a chart trendline. |
| forward |
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. |
| moving |
Represents the period of a chart trendline. Only applicable to trendlines with the type |
| name | Represents the name of the trendline. Can be set to a string value, a |
| polynomial |
Represents the order of a chart trendline. Only applicable to trendlines with the type |
| show |
True if the equation for the trendline is displayed on the chart. |
| show |
True if the r-squared value for the trendline is displayed on the chart. |
| type | Represents the type of a chart trendline. |
Methods
| delete() | Delete the trendline object. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
Property Details
backwardPeriod
Represents the number of periods that the trendline extends backward.
backwardPeriod: number;Property Value
number
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
format
Represents the formatting of a chart trendline.
readonly format: Excel.ChartTrendlineFormat;Property Value
Remarks
forwardPeriod
Represents the number of periods that the trendline extends forward.
forwardPeriod: number;Property Value
number
Remarks
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: any;Property Value
any
Remarks
label
Represents the label of a chart trendline.
readonly label: Excel.ChartTrendlineLabel;Property Value
Remarks
movingAveragePeriod
Represents the period of a chart trendline. Only applicable to trendlines with the type MovingAverage.
movingAveragePeriod: number;Property Value
number
Remarks
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: string;Property Value
string
Remarks
polynomialOrder
Represents the order of a chart trendline. Only applicable to trendlines with the type Polynomial.
polynomialOrder: number;Property Value
number
Remarks
showEquation
True if the equation for the trendline is displayed on the chart.
showEquation: boolean;Property Value
boolean
Remarks
showRSquared
True if the r-squared value for the trendline is displayed on the chart.
showRSquared: boolean;Property Value
boolean
Remarks
type
Represents the type of a chart trendline.
type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power";Property Value
Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
let seriesCollection = sheet.charts.getItemAt(0).series;
// Get the trendline for series 1 and load its type property.
let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);
trendline.load("type");
await context.sync();
console.log("The trendline type is:" + trendline.type);
});
Method Details
delete()
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.ChartTrendline;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartTrendline;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.ChartTrendlineUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Excel.Interfaces.ChartTrendlineUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.ChartTrendline): void;Parameters
- properties
- Excel.ChartTrendline
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.ChartTrendline object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartTrendlineData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.ChartTrendlineData;