GetDrawingsByName

Returns a collection of drawing objects from the document filtered by their names.

Syntax

expression.GetDrawingsByName(ids);

expression - A variable that represents a ApiDocument class.

Parameters

Name	Required/Optional	Data type	Default	Description
ids	Required	string[]		An array of drawing names to filter by.

Returns

ApiDrawing[]

Example

This example shows how to get all drawings with the specified names from the document.

• Code
• Result

// Get drawings by their names.

// How to retrieve drawings by their names and rotate them.

const doc = Api.GetDocument();
const paragraph = doc.GetElement(0);
const fill1 = Api.CreateSolidFill(Api.RGB(255, 111, 61));
const stroke1 = Api.CreateStroke(0, Api.CreateNoFill());
const drawing1 = Api.CreateShape("rect", 60 * 36000, 35 * 36000, fill1, stroke1);
drawing1.SetName("MyShape1");
paragraph.AddDrawing(drawing1);
const fill2 = Api.CreateSolidFill(Api.RGB(51, 133, 255));
const stroke2 = Api.CreateStroke(0, Api.CreateNoFill());
const drawing2 = Api.CreateShape("rect", 60 * 36000, 35 * 36000, fill2, stroke2);
drawing2.SetName("MyShape2");
paragraph.AddDrawing(drawing2);
const fill3 = Api.CreateSolidFill(Api.RGB(61, 255, 111));
const stroke3 = Api.CreateStroke(0, Api.CreateNoFill());
const drawing3 = Api.CreateShape("rect", 60 * 36000, 35 * 36000, fill3, stroke3);
drawing3.SetName("DifferentShape");
paragraph.AddDrawing(drawing3);
const drawings = doc.GetDrawingsByName(["MyShape1", "MyShape2"]);
for (let i = 0; i < drawings.length; i++) {
	drawings[i].SetRotation(45);
}