MergeShapes
Merges an array of drawings into new shapes. The resulting shapes take the formatting of the first drawing in the array.
note
In the spreadsheet editor, this method is not supported in the document builder and works only in the editor.
Syntax
expression.MergeShapes(drawings, operation);
expression - A variable that represents an Api class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| drawings | Required | Drawing[] | An array of at least two drawings from the same page, slide or sheet. At least one of them must be a shape. | |
| operation | Required | ShapesMergeOperation | The merge operation. |
Returns
Drawing[] | null
Example
Merge two overlapping shapes into a single shape on a worksheet.
// Build a custom shape from simple shapes with the union operation.
// Unite a rectangle and an ellipse on the active sheet into one shape filled with the color of the rectangle.
let worksheet = Api.GetActiveSheet();
let fill1 = Api.CreateSolidFill(Api.Color(255, 111, 61));
let fill2 = Api.CreateSolidFill(Api.Color(51, 51, 51));
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let rectangle = worksheet.AddShape("rect", 60 * 36000, 40 * 36000, fill1, stroke, 1, 0, 2, 0);
let ellipse = worksheet.AddShape("ellipse", 80 * 36000, 80 * 36000, fill2, stroke, 2, 2 * 36000, 2, 0);
Api.MergeShapes([rectangle, ellipse], "union");