---
title: "au-widget-mockup-3d-viewer/au-widget-mockup-3d-viewer | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-mockup-3d-viewer.au-widget-mockup-3d-viewer/"
---

# au-widget-mockup-3d-viewer/au-widget-mockup-3d-viewer

> A widget that is used to render 3D previews based on DAE models.

## Classes

### AuWidgetMockup3DViewer

The following example illustrates how you can use proof images obtained from the ``DesignEditor`` to visualize a model in the `3D-Viewer` widget.
```json
{
  "widgets": [
   {
     "name": "previewer",
     "type": "3d-viewer",
     "params": {
       "showAnimationButtons": false,
       "showCameraButtons": true,
       "items": [
         {
           "images": "{{ $['editor'].proofImageUrls }}",
           "model": "64057c8e12287dfc3d0ecebc"
         }
       ]
     }
   }
 ]
}
```

#### Extends

- [`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase)

#### Constructors

##### Constructor

```ts
new AuWidgetMockup3DViewer(): AuWidgetMockup3DViewer;
```

###### Returns

[`AuWidgetMockup3DViewer`](#auwidgetmockup3dviewer)

###### Overrides

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`constructor`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#constructor)

#### Properties

##### image

```ts
image: string;
```

A base64 URL that links to the rendered model image in the initial position.

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`image`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#image)

##### params

```ts
params: any;
```

Compiled widget configuration.

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`params`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#params)

##### paused

```ts
paused: boolean = false;
```

If `true`, animation is paused.

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`paused`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#paused)

##### speed

```ts
speed: number = 1;
```

The current animation speed.

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`speed`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#speed)

#### Accessors

##### backOfficeUrl

###### Get Signature

```ts
get backOfficeUrl(): string;
```

###### Returns

`string`

##### designAtomsApiUrl

###### Get Signature

```ts
get designAtomsApiUrl(): string;
```

###### Returns

`string`

##### ownerId

###### Get Signature

```ts
get ownerId(): string;
```

###### Returns

`string`

##### tenantId

###### Get Signature

```ts
get tenantId(): number;
```

###### Returns

`number`

##### token

###### Get Signature

```ts
get token(): string;
```

###### Returns

`string`

#### Methods

##### checkInitDependenciesWidgets()

```ts
checkInitDependenciesWidgets(): string[];
```

Returns an array of widget names, due to which the current widget cannot receive parameters.

###### Returns

`string`[]

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`checkInitDependenciesWidgets`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#checkinitdependencieswidgets)

##### closeBox()

```ts
closeBox(): void;
```

Closes the dynamic model.

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`closeBox`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#closebox)

##### GetAnimationDuration()

```ts
GetAnimationDuration(): number;
```

Gets the longest animation time in the model.

###### Returns

`number`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`GetAnimationDuration`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#getanimationduration)

##### openBox()

```ts
openBox(): void;
```

Opens the dynamic model.

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`openBox`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#openbox)

##### PauseAnimation()

```ts
PauseAnimation(): void;
```

Pauses animation.

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`PauseAnimation`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#pauseanimation)

##### PlayAnimation()

```ts
PlayAnimation(): void;
```

Plays animation.

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`PlayAnimation`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#playanimation)

##### resetPreloaderState()

```ts
resetPreloaderState(): void;
```

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`resetPreloaderState`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#resetpreloaderstate)

##### SetAnimationAt()

```ts
SetAnimationAt(value): void;
```

Navigates to animation time.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `value` | `number` | The animation time. |

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`SetAnimationAt`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#setanimationat)

##### SetAnimationSpeed()

```ts
SetAnimationSpeed(value): void;
```

Sets the animation speed.

`1` - the default speed.

`<0` - reverse animation.

`-1` - the default speed for reverse animation.

`0` - pause.

`>1` - increments speed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `number` |

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`SetAnimationSpeed`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#setanimationspeed)

##### showPreloader()

```ts
showPreloader(
   isPreload, 
   message?, 
   timeout?): void;
```

Shows a preloader.

```
"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]
```

###### Parameters

| Parameter | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| `isPreload` | `boolean` | `undefined` | If `true`, enables the preloader. |
| `message` | `string` \| `string`[] | `...` | A text message that appears next to the preloader. |
| `timeout` | `number` | `5` | - |

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`showPreloader`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#showpreloader)

##### showToast()

```ts
showToast(data?, duration?): void;
```

Shows a toast.

```
return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });
```

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data?` | `string` | A string message to display in the toast. |
| `duration?` | `number` | Defines how long to show the toast for. |

###### Returns

`void`

###### Inherited from

[`Au3dViewerBase`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#abstract-au3dviewerbase).[`showToast`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.Au3dViewerBase.md#showtoast)

## References

### widget

Renames and re-exports [AuWidgetMockup3DViewer](#auwidgetmockup3dviewer)