Development | Web SDK Reference

Reference docs for each of the full list of methods and functions available in the SDK.

Initialization methods

Method	Description
.createContext()	Used to initialize and setup the SDK. All other SDK methods must be called after this one.
.canVisualizeForBrowser()	Checks if browser compatibility to visualize the web configurator.

Method	Description
.setValue()	Sets the value of a parameter.
.order()	Creates an order of the current configuration
.renderPreview()	Render a preview image of the 3D scene.
.getAvailableProducts()	Returns a list of available products to load in the web configurator.
.hasProductKey()	Returns a boolean if the specified product key is available in the script
.getStaticViews()	Get a list of static views that are defined on a product template.
.generatePDFFromOrder()	Uses the response from the `.order()` method and generates a PDF of the order
.getAvailableARModes()	Returns an array of all of the AR modes available on the current device
.startAr()	Starts AR using the current loaded product
.dispose()	Cleans up and releases all resources used by the web configurator instance. This method should be called when the configurator is no longer needed, such as when navigating away from the page or destroying the component.