Excel.ShapeGroup class

Package:

excel

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

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
id	Specifies the shape identifier.
shape	Returns the Shape object associated with the group.
shapes	Returns the collection of Shape objects.

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.

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

Excel.RequestContext

id

Specifies the shape identifier.

readonly id: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

shape

Returns the Shape object associated with the group.

readonly shape: Excel.Shape;

Property Value

Excel.Shape

Remarks

[ API set: ExcelApi 1.9 ]

shapes

Returns the collection of Shape objects.

readonly shapes: Excel.GroupShapeCollection;

Property Value

Excel.GroupShapeCollection

Remarks

[ API set: ExcelApi 1.9 ]

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

Excel.ShapeGroup

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

Excel.ShapeGroup

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

Excel.ShapeGroup

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

Excel.Interfaces.ShapeGroupData

ungroup()

Ungroups any grouped shapes in the specified shape group.

ungroup(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.9 ]

Examples

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