Developer

Appearance

Initialization and options

Initialize rooomProducts Viewer API with ProductViewer constructor for e-commerce and product configurators. Learn iframe binding, product-specific configuration options, and viewer instance setup.

ProductViewer(iframe) ​

This constructor returns a new rooom product viewer instance bound to the specified iframe element.

js
var iframe = document.getElementById("product-viewer");
var viewer = new ProductViewer(iframe);

init(id, options) ​

This function initializes a viewer with the specified ID. The ID is the identifier part in a viewer URL. You can also pass an options object to this function. See available options.

js
viewer.init("VIEWER_ID", {
  onSuccess: function onSuccessFn(api) {},
  onError: function onErrorFn() {},
  autospin: 1,
  autostart: 1,
  bg_color: "ffd700",
});

Customization ​

You can pass callbacks and customization options when you initialize a viewer.

Alternatively, you can pass customization options as URL parameters, as described in the URL parameters customization guide.

Callbacks ​

onSuccess - function(api)

Required. This callback will be invoked when the viewer has been successfully initialized. It will be passed an API object that allows you to interact with the viewer.

onError - function()

This callback will be invoked when the viewer cannot be initialized.