Document apiReferenceImages

images.setPosition

Set the anchor position for a floating image.

mutates documenttracked modedry runconditional
doc.images.setPosition(…)

Expected result

Returns an ImagesMutationResult.

Inputs

imageIdstringrequired
positionobjectrequired
Fields
hRelativeFromstring
vRelativeFromstring
alignHstring
alignVstring
marginOffsetobject
Fields
horizontalnumber
topnumber

Result

Output fields
successboolean
imageobject
failureobject

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • AMBIGUOUS_TARGET
  • INVALID_TARGET
1 more codes
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • NO_OP

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas