Excel.ShapeGroup class

包:

excel

表示工作表内的形状组。 若要获取相应的 Shape 对象，请使用 ShapeGroup.shape。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
id	指定形状标识符。
shape	返回与 Shape 组关联的 对象。
shapes	返回 对象的集合 Shape 。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.ShapeGroup 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ShapeGroupData) ，该对象包含从原始对象加载的任何子属性的浅表副本。
ungroup()	取消分组指定形状组中的任何已分组形状。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

id

指定形状标识符。

readonly id: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

shape

返回与 Shape 组关联的 对象。

readonly shape: Excel.Shape;

属性值

Excel.Shape

注解

[ API 集：ExcelApi 1.9 ]

shapes

返回 对象的集合 Shape 。

readonly shapes: Excel.GroupShapeCollection;

属性值

Excel.GroupShapeCollection

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup;

参数

options

Excel.Interfaces.ShapeGroupLoadOptions

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

返回

Excel.ShapeGroup

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ShapeGroup

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ShapeGroup

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.ShapeGroup 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ShapeGroupData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.ShapeGroupData;

返回

Excel.Interfaces.ShapeGroupData

ungroup()

取消分组指定形状组中的任何已分组形状。

ungroup(): void;

返回

void

注解

[ API 集：ExcelApi 1.9 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-groups.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Shapes");

    const shapeGroup = sheet.shapes.getItem("Group").group;
    shapeGroup.ungroup();
    console.log("Shapes ungrouped");

    await context.sync();
});