Skip to main content

GetDrawingsByName

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

Syntax​

expression.GetDrawingsByName(ids);

expression - A variable that represents a ApiPresentation class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
idsRequiredstring[]An array of drawing names to filter by.

Returns​

Drawing[]

Example​

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

// Get drawings by their names.

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

const presentation = Api.GetPresentation();
const slide = presentation.GetSlideByIndex(0);
slide.RemoveAllObjects();
const fill1 = Api.CreateSolidFill(Api.RGB(255, 111, 61));
const stroke1 = Api.CreateStroke(0, Api.CreateNoFill());
const shape1 = Api.CreateShape("rect", 60 * 36000, 35 * 36000, fill1, stroke1);
shape1.SetPosition(0, 2 * 36000);
shape1.SetName("MyShape1");
slide.AddObject(shape1);
const fill2 = Api.CreateSolidFill(Api.RGB(51, 133, 255));
const stroke2 = Api.CreateStroke(0, Api.CreateNoFill());
const shape2 = Api.CreateShape("rect", 60 * 36000, 35 * 36000, fill2, stroke2);
shape2.SetPosition(0, 40 * 36000);
shape2.SetName("MyShape2");
slide.AddObject(shape2);
const fill3 = Api.CreateSolidFill(Api.RGB(61, 255, 111));
const stroke3 = Api.CreateStroke(0, Api.CreateNoFill());
const shape3 = Api.CreateShape("rect", 60 * 36000, 35 * 36000, fill3, stroke3);
shape3.SetPosition(70 * 36000, 2 * 36000);
shape3.SetName("DifferentShape");
slide.AddObject(shape3);
const drawings = presentation.GetDrawingsByName(["MyShape1", "MyShape2"]);
for (let i = 0; i < drawings.length; i++) {
	drawings[i].SetRotation(45);
}