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

# au-widget-3d-viewer/Au3dViewerBase

> The base class for widgets.

## Classes

### `abstract` Au3dViewerBase

#### Extends

- [`AuBaseWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubasewidget)

#### Extended by

- [`AuWidget3DViewer`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-3d-viewer.au-widget-3d-viewer.md#auwidget3dviewer)
- [`AuWidgetMockup3DViewer`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-mockup-3d-viewer.au-widget-mockup-3d-viewer.md#auwidgetmockup3dviewer)

#### Constructors

##### Constructor

```ts
new Au3dViewerBase(): Au3dViewerBase;
```

###### Returns

[`Au3dViewerBase`](#abstract-au3dviewerbase)

###### Inherited from

[`AuBaseWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubasewidget).[`constructor`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#constructor-1)

#### Properties

##### image

```ts
image: string;
```

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

##### params

```ts
params: any;
```

Compiled widget configuration.

###### Inherited from

[`AuBaseWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubasewidget).[`params`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#params-1)

##### paused

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

If `true`, animation is paused.

##### speed

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

The current animation speed.

#### Methods

##### checkInitDependenciesWidgets()

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

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

###### Returns

`string`[]

###### Inherited from

[`AuBaseWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubasewidget).[`checkInitDependenciesWidgets`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#checkinitdependencieswidgets-1)

##### closeBox()

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

Closes the dynamic model.

###### Returns

`void`

##### GetAnimationDuration()

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

Gets the longest animation time in the model.

###### Returns

`number`

##### openBox()

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

Opens the dynamic model.

###### Returns

`void`

##### PauseAnimation()

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

Pauses animation.

###### Returns

`void`

##### PlayAnimation()

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

Plays animation.

###### Returns

`void`

##### resetPreloaderState()

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

###### Returns

`void`

###### Inherited from

[`AuBaseWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubasewidget).[`resetPreloaderState`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#resetpreloaderstate-1)

##### SetAnimationAt()

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

Navigates to animation time.

###### Parameters

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

###### Returns

`void`

##### 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`

##### 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

[`AuBaseWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubasewidget).[`showPreloader`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#showpreloader-1)

##### 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

[`AuBaseWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubasewidget).[`showToast`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#showtoast-1)