Skip to main content

CreateShape

Creates a shape with the parameters specified.

Syntax

expression.CreateShape(shapeType, width, height, fill, stroke);

expression - A variable that represents a Api class.

Parameters

NameRequired/OptionalData typeDefaultDescription
shapeTypeOptionalShapeType"rect"The shape type which specifies the preset shape geometry.
widthOptionalEMU72The shape width in English measure units.
heightOptionalEMU72The shape height in English measure units.
fillOptionalApiFillApi.CreateNoFill()The color or pattern used to fill the shape.
strokeOptionalApiStrokeApi.CreateStroke(0, Api.CreateNoFill())The stroke used to create the element shadow.

Returns

ApiShape

Example

Insert a flowchart shape with text and colors in a PDF.

// How do I add a shape and populate it with text in a PDF?

// Create a shape with colored background and multiple text runs in a PDF.

const doc = Api.GetDocument();
const page = doc.GetPage(0);

const fill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);

let run = Api.CreateRun();
run.SetFontSize(60);
run.AddText("This is just a sample text. ");
paragraph.AddElement(run);

run = Api.CreateRun();
run.SetFontSize(60);
run.SetFontFamily("Comic Sans MS");
run.AddText("This is a text run with the font family set to 'Comic Sans MS'.");
paragraph.AddElement(run);
page.AddObject(shape);