Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Set the z-order (relativeHeight) for a floating image.
  • Operation ID: images.setZOrder
  • API member path: editor.doc.images.setZOrder(...)
  • Mutates document: yes
  • Idempotency: conditional
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns an ImagesMutationResult.

​
Input fields

FieldTypeRequiredDescription
imageIdstringyes
zOrderobjectyes
zOrder.relativeHeightintegeryes

​
Example request

{
  "imageId": "example",
  "zOrder": {
    "relativeHeight": 1
  }
}

​
Output fields

FieldTypeRequiredDescription
failureobjectno
imageobjectno
successbooleanno

​
Example response

{
  "image": {},
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • AMBIGUOUS_TARGET
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • NO_OP

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "imageId": {
      "type": "string"
    },
    "zOrder": {
      "additionalProperties": false,
      "properties": {
        "relativeHeight": {
          "maximum": 4294967295,
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "relativeHeight"
      ],
      "type": "object"
    }
  },
  "required": [
    "imageId",
    "zOrder"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "type": "object"
    },
    "image": {
      "type": "object"
    },
    "success": {
      "type": "boolean"
    }
  },
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "image": {
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "image"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}