Excel.ChartTrendlineCollection class
Represents a collection of chart trendlines.
- Extends
Remarks
Properties
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
items | Gets the loaded child items in this collection. |
Methods
add(type) | Adds a new trendline to trendline collection. |
add(type |
Adds a new trendline to trendline collection. |
get |
Returns the number of trendlines in the collection. |
get |
Gets a trendline object by index, which is the insertion order in the items array. |
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 |
toJSON() | Overrides the JavaScript |
Property Details
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
items
Gets the loaded child items in this collection.
readonly items: Excel.ChartTrendline[];
Property Value
Method Details
add(type)
Adds a new trendline to trendline collection.
add(type?: Excel.ChartTrendlineType): Excel.ChartTrendline;
Parameters
Specifies the trendline type. The default value is "Linear". See Excel.ChartTrendline
for details.
Returns
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;
// Add a trendline.
seriesCollection.getItemAt(0).trendlines.add("Linear");
await context.sync();
});
add(typeString)
Adds a new trendline to trendline collection.
add(typeString?: "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"): Excel.ChartTrendline;
Parameters
- typeString
-
"Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"
Specifies the trendline type. The default value is "Linear". See Excel.ChartTrendline
for details.
Returns
Remarks
getCount()
Returns the number of trendlines in the collection.
getCount(): OfficeExtension.ClientResult<number>;
Returns
OfficeExtension.ClientResult<number>
Remarks
getItem(index)
Gets a trendline object by index, which is the insertion order in the items array.
getItem(index: number): Excel.ChartTrendline;
Parameters
- index
-
number
Represents the insertion order in the items array.
Returns
Remarks
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.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection;
Parameters
- options
-
Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.ChartTrendlineCollection;
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?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection;
Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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 is passed to it.) Whereas the original Excel.ChartTrendlineCollection
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.ChartTrendlineCollectionData
) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.ChartTrendlineCollectionData;
Returns
Office Add-ins