通过

Excel.ChartPointsCollection class

包:
excel

图表中某个系列的所有图表点的集合。

扩展
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml

// This function adds data labels to specific chart points 
// and sets their text and position.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  await context.sync();

  const series = chart.series.getItemAt(0);
  series.points.load("dataLabel");
  await context.sync();
  
  // Define properties for data label positioning and shape.
  const labelProperties = [
    {
      top: 70,
      geometricShapeType: Excel.GeometricShapeType.rectangle
    },
    {
      top: 200,
      geometricShapeType: Excel.GeometricShapeType.rectangle
    }
  ];

  // Add data labels to specific chart points and set their text and properties.
  for (let i = 0; i < dataLabelInfo.length; i++) {
    const point = series.points.getItemAt(dataLabelInfo[i].index);
    point.hasDataLabel = true;

    const dataLabel = point.dataLabel;
    dataLabel.text = dataLabelInfo[i].news;
    dataLabel.set(labelProperties[i]);
  }
  await context.sync();
});

属性

context

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

返回系列中的图表点数。
items

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

方法

getCount()

返回系列中的图表点数。
getItemAt(index)

根据其在系列中的位置检索点。
load(options)

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

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

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

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始Excel.ChartPointsCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartPointsCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

count

返回系列中的图表点数。

readonly count: number;

属性值

number

注解

[ API 集：ExcelApi 1.1 ]

items

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

readonly items: Excel.ChartPoint[];

属性值

Excel.ChartPoint[]

方法详细信息

getCount()

返回系列中的图表点数。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

[ API 集：ExcelApi 1.4 ]

getItemAt(index)

根据其在系列中的位置检索点。

getItemAt(index: number): Excel.ChartPoint;

参数

index

number

要检索的对象的索引值。 从零开始编制索引。

返回

Excel.ChartPoint

注解

[ API 集：ExcelApi 1.1 ]

示例

// Set the border color for the first points in the points collection.
await Excel.run(async (context) => { 
    const points = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points;
    points.getItemAt(0).format.fill.setSolidColor("8FBC8F");
    await context.sync();
    
    console.log("Point Border Color Changed");
});

load(options)

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

load(options?: Excel.Interfaces.ChartPointsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartPointsCollection;

参数

options

Excel.Interfaces.ChartPointsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

提供要加载对象的属性的选项。

返回

Excel.ChartPointsCollection

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ChartPointsCollection

示例

// Get the number of points.
await Excel.run(async (context) => { 
    const pointsCollection = 
        context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points;
    pointsCollection.load('count');
    await context.sync();
    console.log("points: Count= " + pointsCollection.count);
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.ChartPointsCollection

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始Excel.ChartPointsCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartPointsCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

toJSON(): Excel.Interfaces.ChartPointsCollectionData;

返回

Excel.Interfaces.ChartPointsCollectionData