Introduction
The 3D viewer web component is the 3D standalone viewer provided by TraceParts.
Description
This web component provides a 3D viewer of the 3D model of one given configuration of a catalog.
Building a URL
The 3D viewer request takes the following form:
https://www.traceparts.com/els/{elsid}/en/api/viewer/3d?parameters
Parameters
Certain parameters are required while others are optional. As it is standard in URLs, all parameters are separated using the ampersand (&) character. The list of parameters and their possible values are enumerated below.
The final URL containing your EasyLink ID (ELSID) is provided with the Tenant Unique ID and the API key.
Required parameters
| Parameter Name | Data type | Default value | Description |
|---|---|---|---|
| SupplierID** | string | none | ClassificationCode provided by the "availability" endpoints |
| PartNumber** | string | none | Identifier of a product (to use in combination with SupplierID). Part number as stored in the TraceParts database. |
| Product* | string | none | PartFamilyCode provided by the "availability" endpoints |
*Both parameters (Product and SelectionPath) have to be used together. In this case, the couple “SupplierID” and “PartNumber” is not to use.
** Both parameters (SupplierID and PartNumber) have to be used together. In this case, the couple “Product” and “SelectionPath” is not to use.
Optional parameters (rendering)
| Parameter Name | Data type | Default value | Description |
|---|---|---|---|
| SelectionPath* | string | none | Sequence of parameters which defines a unique configuration for one given partFamilyCode. |
| SetBackgroundColor | Hexadecimal | 0xFFFFFF | Sets a color on the background of the 3D viewer. |
| SetRenderMode | text | shaded-edged | Rendering of the 3D model. Values: “shaded-edged”, “shaded”, “transparent”, “wireframe”, “edged” |
| EnableMirrorEffect | boolean | false | Enable the mirror effect on the XZ plane |
| DisplayCoordinateSystem | boolean | false | Display the coordinate system |
| EnablePresentationMode | boolean | false | The model rotates on the Y axis until a user interaction |
Optional parameters (toolbars)
| Parameter Name | Data type | Default value | Description |
|---|---|---|---|
| DisplayUIMenu | boolean | true | Display the toolbars (on the bottom and on the right) |
| DisplayUIContextMenu | boolean | true | Enable the contextual menu with Views and Render sub menus |
| MergeUIMenu | boolean | false | Merge the contextual menu inside the main menu |
| MenuAlwaysVisible | boolean | false | Always display the toolbar |
| DisplayUIResetButtonMenu | boolean | true | Display the Reset button |
| DisplayUIScreenshotButtonMenu | boolean | true | Display the Screenshot button |
| DisplayUISettingsSubMenu | boolean | true | Display the Settings menu |
| DisplayUIPresentationModeButtonMenu | boolean | true | Display the Presentation button |
| DisplayUIViewsSubContextMenu | boolean | true | Display the Views sub menu (for the contextual menu) |
| DisplayUIRenderModesSubContextMenu | boolean | true | Display the Render sub menu (for the contextual menu) |
Example of 3D viewer call
The request below returns the 3D viewer of the part number “1857837” from the PHOENIX CONTACT catalog.
https://www.traceparts.com/els/phoenix-contact/en/api/viewer/3d?SupplierID=PHOENIX_CONTACT&PartNumber=1857837
The language of the menu depends of the URL, having the TraceParts cultureInfo in the path. By default, the 3D viewer is in English language (cultureInfo = en).
https://www.traceparts.com/els/{elsid}/{en}/api/viewer/3d?parameters
Developer support
Please contact us for any problem, question or comment related to this content integration.