Excel.ShapeGroup class

Represents a shape group inside a worksheet. To get the corresponding Shape object, use ShapeGroup.shape.

[ API set: ExcelApi 1.9 ]

Extends
OfficeExtension.ClientObject

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

id

Represents the shape identifier. Read-only.

[ API set: ExcelApi 1.9 ]

shape

Returns the Shape object associated with the group. Read-only.

[ API set: ExcelApi 1.9 ]

shapes

Returns the collection of Shape objects. Read-only.

[ API set: ExcelApi 1.9 ]

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeGroup object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeGroupData) that contains shallow copies of any loaded child properties from the original object.

ungroup()

Ungroups any grouped shapes in the specified shape group.

[ API set: ExcelApi 1.9 ]

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

id

Represents the shape identifier. Read-only.

[ API set: ExcelApi 1.9 ]

readonly id: string;

Property Value

string

shape

Returns the Shape object associated with the group. Read-only.

[ API set: ExcelApi 1.9 ]

readonly shape: Excel.Shape;

Property Value

shapes

Returns the collection of Shape objects. Read-only.

[ API set: ExcelApi 1.9 ]

readonly shapes: Excel.GroupShapeCollection;

Property Value

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options
Excel.Interfaces.ShapeGroupLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNames
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

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

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.

Returns

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeGroup object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeGroupData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ShapeGroupData;

Returns

ungroup()

Ungroups any grouped shapes in the specified shape group.

[ API set: ExcelApi 1.9 ]

ungroup(): void;

Returns

void

Examples

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