# images.setZOrder

> Set the z-order (relativeHeight) for a floating image.



- Member path: `doc.images.setZOrder(…)`
- Mutates document: yes
- Idempotency: `conditional`
- Supports tracked mode: yes
- Supports dry run: yes

## Expected result

Returns an ImagesMutationResult.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {},
  "type": "object",
  "properties": {
    "imageId": {
      "type": "string"
    },
    "zOrder": {
      "type": "object",
      "properties": {
        "relativeHeight": {
          "type": "integer",
          "minimum": 0,
          "maximum": 4294967295
        }
      },
      "additionalProperties": false,
      "required": [
        "relativeHeight"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "imageId",
    "zOrder"
  ]
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {},
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "image": {
      "type": "object"
    },
    "failure": {
      "type": "object"
    }
  },
  "additionalProperties": false
}
```

## Pre-apply throws

- `TARGET_NOT_FOUND`
- `AMBIGUOUS_TARGET`
- `INVALID_TARGET`
- `CAPABILITY_UNAVAILABLE`

## Non-applied receipt codes

- `NO_OP`