Excel.ChartTrendlineCollection class

表示图表趋势线的集合。

扩展

属性

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

items

获取此集合中已加载的子项。

方法

add(type)

向趋势线集合添加新的趋势线。

add(type)

向趋势线集合添加新的趋势线。

getCount()

返回集合中的趋势线数量。

getItem(index)

按索引获取趋势线对象,索引是项数组中的插入顺序。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.ChartTrendlineCollection 对象是 API 对象,但该 toJSON 方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.ChartTrendlineCollectionData) ,其中包含一个“items”数组,其中包含从集合的 items 中加载的任何属性的浅层副本。

属性详细信息

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

items

获取此集合中已加载的子项。

readonly items: Excel.ChartTrendline[];

属性值

方法详细信息

add(type)

向趋势线集合添加新的趋势线。

add(type?: Excel.ChartTrendlineType): Excel.ChartTrendline;

参数

type
Excel.ChartTrendlineType

指定趋势线类型。 默认值为“Linear”。 有关详细信息,请参阅 Excel.ChartTrendline。

返回

注解

API 集:ExcelApi 1.7

示例

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

向趋势线集合添加新的趋势线。

add(type?: "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"): Excel.ChartTrendline;

参数

type

"Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"

指定趋势线类型。 默认值为“Linear”。 有关详细信息,请参阅 Excel.ChartTrendline。

返回

注解

API 集:ExcelApi 1.7

getCount()

返回集合中的趋势线数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

注解

API 集:ExcelApi 1.7

getItem(index)

按索引获取趋势线对象,索引是项数组中的插入顺序。

getItem(index: number): Excel.ChartTrendline;

参数

index

number

表示项数组中的插入顺序。

返回

注解

API 集:ExcelApi 1.7

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection;

参数

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection;

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串,以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.ChartTrendlineCollection 对象是 API 对象,但该 toJSON 方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.ChartTrendlineCollectionData) ,其中包含一个“items”数组,其中包含从集合的 items 中加载的任何属性的浅层副本。

toJSON(): Excel.Interfaces.ChartTrendlineCollectionData;

返回