Interface I3DViewerNewParams

Provides properties that are used to visualize 3D models. For more details, you can refer to the 3D-Viewer widget.

The following example illustrates how you can specify a two-sided model in the 3D-Viewer widget.

{
    "widgets": [{
        "name": "preview",
        "type": "3d-viewer",
        "params": {
            "showAnimationButtons": false,
            "showCameraButtons": false,
            "items": [{
                "images": [
                    "https://example.com/800/600",
                    "https://example.com/1000/601"
                ],
                "model": "64057c8e12287dfc3d0ecebc"
            }]
        }
    }]
}

Package: ui-framework

Properties

animationSpeed

Speed of animation playing

Declaration

animationSpeed: number

Property Value

Type	Description
number	Speed of animation playing

backgroundColor

Background color for scene.

Declaration

backgroundColor: string

Property Value

Type	Description
string	Background color for scene.

buttonsPosition

The position of the camera and animation button: left, right, or top. By default: left.

Declaration

buttonsPosition?: ButtonsPosition

Property Value

Type	Description
ButtonsPosition	The position of the camera and animation button: left, right, or top. By default: left.

cameraButtons

Declaration

cameraButtons?: Partial<Object>

Property Value

Type	Description
Partial<Object>

distance

Distance from camera to scene

Declaration

distance?: number

Property Value

Type	Description
number	Distance from camera to scene

items

A collection of objects for visualization.

Declaration

items: I3DItem[]

Property Value

Type	Description
I3DItem[]	A collection of objects for visualization.

modelType

The model type: default or blender.

Declaration

modelType: ModelType

Property Value

Type	Description
ModelType	The model type: default or blender.

orbitsControl

Parameters for OrbitControls. https://threejs.org/docs/#examples/en/controls/OrbitControls

Declaration

orbitsControl?: any

Property Value

Type	Description
any	Parameters for OrbitControls. https://threejs.org/docs/#examples/en/controls/OrbitControls

pauseAtEnd

If true, pauses animation at the last frame.

Declaration

pauseAtEnd: boolean

Property Value

Type	Description
boolean	If true, pauses animation at the last frame.

preloader

Show/hide origami preloader

Declaration

preloader?: boolean

Property Value

Type	Description
boolean	Show/hide origami preloader

saveDistanceWhenMoveCamera

If true, saves camera distance position when select another camera button view.

Declaration

saveDistanceWhenMoveCamera: boolean

Property Value

Type	Description
boolean	If true, saves camera distance position when select another camera button view.

showAnimationButtons

If a model has several elements (for example, if a box consists of a container and a lid), you can set this parameter to true to enable buttons for opening and closing these elements.

Declaration

showAnimationButtons?: boolean

Property Value

Type	Description
boolean	If a model has several elements (for example, if a box consists of a container and a lid), you can set this parameter to true to enable buttons for opening and closing these elements.

showAnimationControls

if true, shows Play\Pause button, animation timeline and animation speed controls.

Declaration

showAnimationControls?: boolean

Property Value

Type	Description
boolean	if true, shows Play\Pause button, animation timeline and animation speed controls.

showCameraButtons

If true, enables camera buttons. If it's a string array - show buttons with that name.

Declaration

showCameraButtons?: boolean

Property Value

Type	Description
boolean	If true, enables camera buttons. If it's a string array - show buttons with that name.