The Embedded Viewer lets you embed 3D viewer of your model on your website.
Although Cloud API has special viewer:read
scope, which allows get visualization data from server securely, but currently it cannot be really used with embedded viewer. Viewer can display public files only which does not required authentication to access to visualization data.
data:read viewer:read
permissions by default.Before display a model in the viewer you should prepare the model to be displayed on your page.
activeRevision
should have success
status).Define an <iframe> tag in your application in which the src URL specifies the content that the viewer will load as well as any other viewer parameters you want to set. The <iframe> tag's height and width parameters specify the dimensions of the viewer.
You can configure your Embedded Viewer to load a specific model and display it using different parameters. Parameters should be added to the IFrame URL as query string.
Name | Type | Default value | Description | |
---|---|---|---|---|
fileId required |
String |
Specifies CAD Exchanger Cloud identificator of the file that you want to display. | ||
autoPlay |
Number | 0 |
Specifies whether the model loading and displaying will automatically start when the viewer loads. When ![]() autoPlay=1 ![]() autoPlay=0 | |
showViewCube |
Number | 0 |
Specifies display ViewCube tool or not. ![]() showViewCube=1 ![]() showViewCube=0 | |
cameraType |
String | isometric |
Specifies camera projection type used by viewer camera. Should be one of ![]() cameraType=isometric ![]() cameraType=perspective | |
displayMode |
String | auto |
Specifies display mode used for model displaying. Should be one of ![]() displayMode= ![]() displayMode= ![]() displayMode= | |
representation |
String | auto |
Specifies representation type used for model displaying. Should be one of ![]() representation= ![]() representation= ![]() representation= ![]() representation=
| |
bg |
String | null |
Specifies background color in css notation. |