ExcelScript.ShapeGroup interface
Represents a shape group inside a worksheet. To get the corresponding Shape
object, use ShapeGroup.shape
.
Methods
get |
Returns the |
get |
Specifies the shape identifier. |
get |
Gets a shape using its name or ID. If the shape object does not exist, then this method returns |
get |
Returns the collection of |
ungroup() | Ungroups any grouped shapes in the specified shape group. |
Method Details
getGroupShape()
Returns the Shape
object associated with the group.
getGroupShape(): Shape;
Returns
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()
ungroup()
Ungroups any grouped shapes in the specified shape group.
ungroup(): void;
Returns
void
Office Scripts