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 path command's endpoint and display it in a spreadsheet.

// How do I find the X coordinate of a drawing command on a shape in a spreadsheet?

// Confirm where a path step lands horizontally within a shape's drawing area in a spreadsheet.

let worksheet = Api.GetActiveSheet();
let fill = Api.CreateSolidFill(Api.RGB(100, 150, 200));
let stroke = Api.CreateStroke(18000, Api.CreateSolidFill(Api.RGB(50, 75, 100)));
let shape = worksheet.AddShape("star5", 60 * 36000, 60 * 36000, fill, stroke, 3, 0, 2, 0);
let geometry = shape.GetGeometry();
let path = geometry.GetPath(0);
let commands = path.GetCommands();
worksheet.GetRange("A8").SetValue("Commands: " + path.GetCommandCount());
let cmd = path.GetCommand(0);
worksheet.GetRange("A9").SetValue("Type: " + cmd.GetType() + " at (" + cmd.GetX() + ", " + cmd.GetY() + ")");