ExcelScript.ShapeGroup interface

Package:

ExcelScript

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

Methods

getGroupShape()	Returns the Shape object associated with the group.
getId()	Specifies the shape identifier.
getShape(key)	Gets a shape using its name or ID. If the shape object does not exist, then this method returns undefined.
getShapes()	Returns the collection of Shape objects.
ungroup()	Ungroups any grouped shapes in the specified shape group.

Method Details

getGroupShape()

Returns the Shape object associated with the group.

getGroupShape(): Shape;

Returns

ExcelScript.Shape

getId()

Specifies the shape identifier.

getId(): string;

Returns

string

getShape(key)

Gets a shape using its name or ID. If the shape object does not exist, then this method returns undefined.

getShape(key: string): Shape | undefined;

Parameters

key

string

The name or ID of the shape to be retrieved.

Returns

ExcelScript.Shape | undefined

getShapes()

Returns the collection of Shape objects.

getShapes(): Shape[];

Returns

ExcelScript.Shape[]

ungroup()

Ungroups any grouped shapes in the specified shape group.

ungroup(): void;

Returns

void