Skip to main content

GetX

Returns the X coordinate for the "moveTo"/"lineTo" path commands.

Syntax

expression.GetX();

expression - A variable that represents a ApiPathCommand class.

Parameters

This method doesn't have any parameters.

Returns

string | null

Example

Read the horizontal position of a point in a shape's outline path in a document.

// How do I find the left-right coordinate of a specific point along a shape's outline in a document?

// Retrieve the horizontal coordinate from a drawing step within a shape's path in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let fill = Api.CreateSolidFill(Api.RGB(255, 200, 100));
let stroke = Api.CreateStroke(36000, Api.CreateSolidFill(Api.RGB(200, 100, 0)));
let shape = Api.CreateShape("star5", 80 * 36000, 80 * 36000, fill, stroke);
let geometry = shape.GetGeometry();
let path = geometry.GetPath(0);
let commands = path.GetCommands();
paragraph.AddText("Command count: " + path.GetCommandCount());
let cmd = path.GetCommand(0);
paragraph.AddText(", First command: " + cmd.GetType() + " (" + cmd.GetX() + ", " + cmd.GetY() + ")");
paragraph.AddDrawing(shape);