Get Started
Usage API
More information

SetPicturePosition

SetPicturePosition(nShiftX, nShiftY) → { boolean }

Sets the picture position inside the current form:

  • 0 - the picture is placed on the left/top;
  • 50 - the picture is placed in the center;
  • 100 - the picture is placed on the right/bottom.

Parameters:

Name Type Description
nShiftX percentage

Horizontal position measured in percent.

nShiftY percentage

Vertical position measured in percent.

Returns:

Type
boolean

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oPictureForm = Api.CreatePictureForm({"key": "Personal information", "tip": "Upload your photo", "required": true, "placeholder": "Photo", "scaleFlag": "tooBig", "lockAspectRatio": true, "respectBorders": false});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oPictureForm);
oPictureForm.SetImage("https://api.onlyoffice.com/content/img/editor/opening.jpg");
oPictureForm.SetPicturePosition(70, 70);
var aPosition = oPictureForm.GetPicturePosition();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Picture position: ");
oParagraph.AddLineBreak();
for (let i = 0; i < aPosition.length; i++ ){
    var nShift = aPosition[i];
    oParagraph.AddText("" + nShift);
    oParagraph.AddLineBreak();
}
oDocument.Push(oParagraph);
builder.SaveFile("docx", "SetPicturePosition.docx");
builder.CloseFile();

Resulting document