Excel.ChartCollection class

工作表中的所有 chart 对象的集合。

注解

使用方

Excel.Worksheet：图表

属性

context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
count	返回工作表中的图表数。
items	获取此集合中已加载的子项。

方法

add(type, sourceData, seriesBy)	创建新图表。
add(type, sourceData, seriesBy)	创建新图表。
getCount()	返回工作表中的图表数。
getItem(name)	使用图表名称获取图表。如果存在多个名称相同的图表，将返回第一个图表。
getItemAt(index)	根据其在集合中的位置获取图表。
getItemOrNullObject(name)	使用图表名称获取图表。如果存在多个名称相同的图表，将返回第一个图表。如果图表不存在，则此方法将返回其 `isNullObject` 属性设置为 `true`的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `Excel.ChartCollection` 对象是 API 对象，但该 `toJSON` 方法返回一个纯 JavaScript 对象， (类型为 `Excel.Interfaces.ChartCollectionData`) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

活动

onActivated	在激活图表时发生。
onAdded	在向工作表添加新图表时发生。
onDeactivated	在图表停用时发生。
onDeleted	在删除图表时发生。

context

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

context: RequestContext;

属性值

Excel.RequestContext

count

返回工作表中的图表数。

readonly count: number;

属性值

number

注解

API 集：ExcelApi 1.1

items

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

readonly items: Excel.Chart[];

属性值

Excel.Chart[]

add(type, sourceData, seriesBy)

创建新图表。

add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy): Excel.Chart;

参数

type: Excel.ChartType

表示图表的类型。有关详细信息，请参阅 Excel.ChartType。

sourceData: Excel.Range

Range与源数据对应的对象。

seriesBy: Excel.ChartSeriesBy

可选。指定列或行在图表上用作数据系列的方式。有关详细信息，请参阅 Excel.ChartSeriesBy。

返回

Excel.Chart

注解

API 集：ExcelApi 1.1

示例

// Add a chart of chartType "ColumnClustered" on worksheet "Charts" 
// with sourceData from range "A1:B4" and seriesBy set to "auto".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sheet1");
    const rangeSelection = "A1:B4";
    const range = sheet.getRange(rangeSelection);
    const chart = sheet.charts.add(
    Excel.ChartType.columnClustered, 
    range, 
    Excel.ChartSeriesBy.auto);
    await context.sync();

    console.log("New Chart Added");
});

add(type, sourceData, seriesBy)

创建新图表。

add(type: "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx", sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): Excel.Chart;

参数

type: "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx"

表示图表的类型。有关详细信息，请参阅 Excel.ChartType。

sourceData: Excel.Range

Range与源数据对应的对象。

seriesBy: "Auto" | "Columns" | "Rows"

可选。指定列或行在图表上用作数据系列的方式。有关详细信息，请参阅 Excel.ChartSeriesBy。

返回

Excel.Chart

注解

API 集：ExcelApi 1.1

getCount()

返回工作表中的图表数。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

API 集：ExcelApi 1.4

getItem(name)

使用图表名称获取图表。如果存在多个名称相同的图表，将返回第一个图表。

getItem(name: string): Excel.Chart;

参数

name: string

要检索的图表的名称。

返回

Excel.Chart

注解

API 集：ExcelApi 1.1

示例

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

getItemAt(index)

根据其在集合中的位置获取图表。

getItemAt(index: number): Excel.Chart;

参数

index: number

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

返回

Excel.Chart

注解

API 集：ExcelApi 1.1

示例

await Excel.run(async (context) => { 
    const lastPosition = context.workbook.worksheets.getItem("Sheet1").charts.count - 1;
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItemAt(lastPosition);
    await context.sync();

    console.log(chart.name);
});

getItemOrNullObject(name)

使用图表名称获取图表。如果存在多个名称相同的图表，将返回第一个图表。如果图表不存在，则此方法将返回其 isNullObject 属性设置为 true的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(name: string): Excel.Chart;

参数

name: string

要检索的图表的名称。

返回

Excel.Chart

注解

API 集：ExcelApi 1.4

load(options)

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

load(options?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection;

参数

options: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.ChartCollection

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

返回

Excel.ChartCollection

示例

await Excel.run(async (context) => { 
    const charts = context.workbook.worksheets.getItem("Sheet1").charts;
    charts.load('items');
    await context.sync();
    
    for (let i = 0; i < charts.items.length; i++) {
        console.log(charts.items[i].name);
    }
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths: OfficeExtension.LoadOption

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

返回

Excel.ChartCollection

toJSON()

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

toJSON(): Excel.Interfaces.ChartCollectionData;

返回

Excel.Interfaces.ChartCollectionData

onActivated

在激活图表时发生。

readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;

事件类型

OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>

注解

API 集：ExcelApi 1.8

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartActivated(event) {
    await Excel.run(async (context) => {
        // Retrieve the worksheet.
        const sheet = context.workbook.worksheets.getActiveWorksheet();

        // Retrieve the activated chart by ID and load the name of the chart. 
        const activatedChart = sheet.charts.getItem(event.chartId);
        activatedChart.load(["name"]);
        await context.sync();

        // Print out the activated chart's data.
        console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`);
    });
}

onAdded

在向工作表添加新图表时发生。

readonly onAdded: OfficeExtension.EventHandlers<Excel.ChartAddedEventArgs>;

事件类型

OfficeExtension.EventHandlers<Excel.ChartAddedEventArgs>

注解

API 集：ExcelApi 1.8

示例

await Excel.run(async (context) => {
    context.workbook.worksheets.getActiveWorksheet()
        .charts.onAdded.add(function (event) {
        return Excel.run(async (context) => {
            console.log("A chart has been added with ID: " + event.chartId);
            await context.sync();
        });
    });
    await context.sync();
});

onDeactivated

在图表停用时发生。

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;

事件类型

OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>

注解

API 集：ExcelApi 1.8

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartDeactivated(event) {
    await Excel.run(async (context) => {
        // Callback function for when the chart is deactivated.
        console.log("The pie chart is NOT active.");
    });
}

onDeleted

在删除图表时发生。

readonly onDeleted: OfficeExtension.EventHandlers<Excel.ChartDeletedEventArgs>;

事件类型

OfficeExtension.EventHandlers<Excel.ChartDeletedEventArgs>

注解

API 集：ExcelApi 1.8

示例

await Excel.run(async (context) => {
    context.workbook.worksheets.getActiveWorksheet()
        .charts.onDeleted.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The chart with this ID was deleted: " + event.chartId);
            await context.sync();
        });
    });
    await context.sync();
});

注解

使用方

属性

方法

活动

属性详细信息

context

属性值

count

属性值

注解

items

属性值

方法详细信息

add(type, sourceData, seriesBy)

参数

返回

注解

示例

add(type, sourceData, seriesBy)

参数

返回

注解

getCount()

返回

注解

getItem(name)

参数

返回

注解

示例

getItemAt(index)

参数

返回

注解

示例

getItemOrNullObject(name)

参数

返回

注解

load(options)

参数

返回

load(propertyNames)

参数

返回

示例

load(propertyNamesAndPaths)

参数

返回

toJSON()

返回

事件详细信息

onActivated

事件类型

注解

示例

onAdded

事件类型

注解

示例

onDeactivated

事件类型

注解

示例

onDeleted

事件类型

注解

示例

反馈