API Reference
The configurator expects messages in the following format:
Sending a message can be done as follows:
Method name | Description and Parameters |
showUi | Shows or hides the default user interface.
- |
saveSnapshot | Initiates the download of a JPG file of the currently rendered view of the configurator. |
options | Prints all the possible configuration options with their IDs to the console. |
option | Sets a specific configuration based on the parameters below.
- |
setMaterial | Sets the material of the specific |
Events
In order to receive events from the iframe window, you have to initialize an event listener on the main window as follows:
Event name | Description and Parameters |
loadingCompleted | Triggered when the configurator finished loading. |
keydown | Triggered on the keydown event. Given that the main window cannot access the keydown event of the iframe directly, this makes it possible to capture a subset of those events.
- |
settingMaterialCompleted | Triggered when setting a specific material using the setMaterial method finished. |
Last updated