---
title: Image
slug: viewer-3d/typesimage
docTags: 
createdAt: 2026-09-17T10:53:55.169Z
---

## Properties

| **Name**       | **Type** | **Required** | **Description**                                         |
| -------------- | -------- | ------------ | ------------------------------------------------------- |
| `clippable`    | Boolean  | No           | Image is cut by the active clipping planes              |
| `data`         | Object   | No           | Raw pixel data of the image. Use either `url` or `data` |
| `id`           | String   | No           | User provided id for the image                          |
| `interactable` | Boolean  | No           | Image can be used as zoom target and rotation pivot     |
| `opacity`      | Number   | No           | Opacity of the image, from 0 to 1                       |
| `size`         | Object   | Yes          | Dimensions of the image in pixels                       |
| `transform`    | Object   | No           | Transform applied to the image                          |
| `url`          | String   | No           | Url of the image. Use either `url` or `data`            |

**Data**

| **Name** | **Type**                        | **Required** | **Description**                     |
| -------- | ------------------------------- | ------------ | ----------------------------------- |
| `data`   | Uint8Array \| Uint8ClampedArray | Yes          | 8-bit pixel data, row by row        |
| `format` | String                          | No           | `rgb` or `rgba`. Defaults to `rgba` |
| `height` | Number                          | Yes          | Height of the pixel data in pixels  |
| `width`  | Number                          | Yes          | Width of the pixel data in pixels   |

**Size**

| **Name** | **Type** | **Required** | **Description**               |
| -------- | -------- | ------------ | ----------------------------- |
| `height` | Number   | Yes          | Height of the image in pixels |
| `width`  | Number   | Yes          | Width of the image in pixels  |

**Transform**

| **Name**   | **Type**     | **Required** | **Description**    |
| ---------- | ------------ | ------------ | ------------------ |
| `position` | [Vector3](#) | No           | Location of image  |
| `rotation` | Object       | No           | Rotation transform |

**Rotation**

| **Name**           | **Type**     | **Required** | **Description**      |
| ------------------ | ------------ | ------------ | -------------------- |
| `angle`            | Number       | No           | Angle in radians     |
| `centerOfRotation` | [Vector3](#) | No           | Point to rotate over |
| `x`                | Number       | Yes          | X axis rotation      |
| `y`                | Number       | Yes          | Y axis rotation      |
| `z`                | Number       | Yes          | Z axis rotation      |