Excel.ChartTrendline class

此对象表示图表趋势线对象的属性。This object represents the attributes for a chart trendline object.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

Extends

属性

backwardPeriod

表示趋势线向后延伸的周期数。Represents the number of periods that the trendline extends backward.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

format

表示图表趋势线的格式。Represents the formatting of a chart trendline.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

forwardPeriod

表示趋势线向前延伸的周期数。Represents the number of periods that the trendline extends forward.

[API 集: ExcelApi 1.8][ 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.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

label

表示图表趋势线的标签。Represents the label of a chart trendline.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

movingAveragePeriod

表示图表趋势线的周期。Represents the period of a chart trendline. 仅适用于 MovingAverage 类型的趋势线。Only applicable for trendline with MovingAverage type.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

name

表示趋势线的名称。Represents the name of the trendline. 可设为字符串值,或者设为 Null 值(表示自动值)。Can be set to a string value, or can be set to null value represents automatic values. 返回的值始终为字符串The returned value is always a string

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

polynomialOrder

表示图表趋势线的顺序。Represents the order of a chart trendline. 仅适用于具有多项式类型的趋势线。Only applicable for trendline with Polynomial type.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

showEquation

如果图表上显示趋势线公式,则为 True。True if the equation for the trendline is displayed on the chart.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

showRSquared

如果图表上显示趋势线的 R 平方值,则为 True。True if the R-squared for the trendline is displayed on the chart.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

type

表示图表趋势线的类型。Represents the type of a chart trendline.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

方法

delete()

删除 Trendline 对象。Delete the trendline object.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

set(properties, options)

同时设置一个对象的多个属性。Sets multiple properties of an object at the same time. 您可以传递具有相应属性的纯对象或相同类型的其他 API 对象。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()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始 ChartTrendline 对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.ChartTrendlineData, in turn, calls the toJSON method of the object that is 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.

属性详细信息

backwardPeriod

表示趋势线向后延伸的周期数。Represents the number of periods that the trendline extends backward.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

backwardPeriod: number;

属性值

number

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

context: RequestContext;

属性值

RequestContext

format

表示图表趋势线的格式。Represents the formatting of a chart trendline.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

readonly format: Excel.ChartTrendlineFormat;

属性值

forwardPeriod

表示趋势线向前延伸的周期数。Represents the number of periods that the trendline extends forward.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

forwardPeriod: number;

属性值

number

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.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

intercept: any;

属性值

any

label

表示图表趋势线的标签。Represents the label of a chart trendline.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

readonly label: Excel.ChartTrendlineLabel;

属性值

movingAveragePeriod

表示图表趋势线的周期。Represents the period of a chart trendline. 仅适用于 MovingAverage 类型的趋势线。Only applicable for trendline with MovingAverage type.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

movingAveragePeriod: number;

属性值

number

name

表示趋势线的名称。Represents the name of the trendline. 可设为字符串值,或者设为 Null 值(表示自动值)。Can be set to a string value, or can be set to null value represents automatic values. 返回的值始终为字符串The returned value is always a string

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

name: string;

属性值

string

polynomialOrder

表示图表趋势线的顺序。Represents the order of a chart trendline. 仅适用于具有多项式类型的趋势线。Only applicable for trendline with Polynomial type.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

polynomialOrder: number;

属性值

number

showEquation

如果图表上显示趋势线公式,则为 True。True if the equation for the trendline is displayed on the chart.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

showEquation: boolean;

属性值

boolean

showRSquared

如果图表上显示趋势线的 R 平方值,则为 True。True if the R-squared for the trendline is displayed on the chart.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

showRSquared: boolean;

属性值

boolean

type

表示图表趋势线的类型。Represents the type of a chart trendline.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

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

属性值

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

示例Examples

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()

删除 Trendline 对象。Delete the trendline object.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

delete(): void;

返回

void

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline;

参数

返回

注解

除了此签名之外, 此方法还具有以下签名:In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.ChartTrendline-Where 选项是一个逗号分隔的字符串或一个字符串数组, 用于指定要加载的属性。load(option?: string | string[]): Excel.ChartTrendline - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ChartTrendline-Where 选项。选择是一个用逗号分隔的字符串, 用于指定要加载的属性和选项。 expand 是一个用逗号分隔的字符串, 用于指定要加载的导航属性。load(option?: { select?: string; expand?: string; }): Excel.ChartTrendline - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendline-仅适用于集合类型。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTrendline - Only available on collection types. 它类似于前面的签名。It is similar to the preceding signature. top 指定结果中可包含的集合项的最大数量。Option.top specifies the maximum number of collection items that can be included in the result. 选项。 skip 指定要跳过且不包含在结果中的项目数。Option.skip specifies the number of items that are to be skipped and not included in the result. 如果指定了 top 选项, 则在跳过指定数目的项目后将启动结果集。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.ChartTrendline;

参数

propertyNames
string | string[]

一个以逗号分隔的字符串或字符串数组, 用于指定要加载的属性。A comma-delimited string or an array of strings that specify the properties to load.

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartTrendline;

参数

propertyNamesAndPaths
{ select?: string; expand?: string; }

其中, propertyNamesAndPaths 是用逗号分隔的字符串, 用于指定要加载的属性和 propertyNamesAndPaths。扩展是一个用逗号分隔的字符串, 用于指定要加载的导航属性。Where 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.

返回

set(properties, options)

同时设置一个对象的多个属性。Sets multiple properties of an object at the same time. 您可以传递具有相应属性的纯对象或相同类型的其他 API 对象。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;

参数

properties
Interfaces.ChartTrendlineUpdateData

一个 JavaScript 对象, 其属性的结构 isomorphically 为在其上调用方法的对象的属性。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

提供一个选项, 以在 properties 对象尝试设置任何只读属性时禁止显示错误。Provides an option to suppress errors if the properties object tries to set any read-only properties.

返回

void

注解

此方法具有以下附加签名:This method has the following additional signature:

set(properties: Excel.ChartTrendline): void

set(properties)

基于现有加载的对象同时设置该对象的多个属性。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartTrendline): void;

参数

返回

void

toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始 ChartTrendline 对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.ChartTrendlineData, in turn, calls the toJSON method of the object that is 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;

返回