Excel.ChartTrendline class
此对象表示图表趋势线对象的属性。
- 扩展
注解
属性
| backward |
表示趋势线向后延伸的周期数。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| format | 表示图表趋势线的格式。 |
| forward |
表示趋势线向前延伸的周期数。 |
| intercept | 表示趋势线的截距值。 可以设置为数字值或空字符串（对于自动值）。 返回的值始终为数字。 |
| label | 表示图表趋势线的标签。 |
| moving |
表示图表趋势线的周期。 仅适用于类型 |
| name | 表示趋势线的名称。 可以设置为字符串值， |
| polynomial |
表示图表趋势线的顺序。 仅适用于类型 |
| show |
如果图表上显示趋势线公式，则为 True。 |
| show |
如此 如果趋势线的 r 平方值显示在图表上。 |
| type | 表示图表趋势线的类型。 |
方法
| delete() | 删除 Trendline 对象。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
backwardPeriod
context
format
表示图表趋势线的格式。
readonly format: Excel.ChartTrendlineFormat;属性值
注解
forwardPeriod
intercept
label
表示图表趋势线的标签。
readonly label: Excel.ChartTrendlineLabel;属性值
注解
movingAveragePeriod
表示图表趋势线的周期。 仅适用于类型 MovingAverage为 的趋势线。
movingAveragePeriod: number;属性值
number
注解
name
polynomialOrder
showEquation
showRSquared
type
表示图表趋势线的类型。
type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power";属性值
Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"
注解
示例
// 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);
});
方法详细信息
delete()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ChartTrendline;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartTrendline;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.ChartTrendlineUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.ChartTrendlineUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Excel.ChartTrendline): void;参数
- properties
- Excel.ChartTrendline
返回
void
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 Excel.ChartTrendline 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartTrendlineData) ，该对象包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.ChartTrendlineData;