Minimum Requirements

  • Install plattar-ar-adapter SDK (see installation section)
  • Website must be hosted and using https protocol
  • Browser must support webgl 1 & 2 (supported by modern browsers)

Supported Attributes

The following HTML Attributes are supported by plattar-ar-adapter SDK nodes

  • width (optional)

Sets the width for the Viewer in pixels. This attribute is optional and default value is 500px.

<plattar-embed width="500px" />
  • height (optional)

Sets the height for the Viewer in pixels. This attribute is optional and default value is 500px.

<plattar-embed height="500px" />
  • scene-id (optional)

Scene ID is aquired from the Plattar CMS. Every Scene in the Plattar Ecosystem is designated a unique GUID. Use that Scene ID to embed a particular Scene onto your website. This attribute is optional and is disabled by default.

<plattar-embed scene-id="" />
  • product-id (optional)

Product ID is aquired from the Plattar CMS. Every Product in the Plattar Ecosystem is designated a unique GUID. Use that Product ID to embed a particular Product onto your website. This attribute is optional and is disabled by default.

The product-id attribute is ignored when the scene-id attribute is present.

<plattar-embed product-id="" />
  • variation-id (optional)

Variation ID is aquired from the Plattar CMS. Every Variation in the Plattar Ecosystem is designated a unique GUID. Use that Variation ID in conjunction with the Product ID to embed a particular Product & Variation onto your website. This attribute is optional and is disabled by default.

The variation-id attribute is ignored when the scene-id attribute is present and requires that a product-id attribute be present.

<plattar-embed variation-id="" />
  • init (optional)

Init attribute is an enumerator that allows controlling the embed without using additional JavaScript. Init must be one of the following. This attribute is optional and is disabled by default.

  1. viewer - Attempts to launch a 3D Viewer if available
  2. qrcode - Displays a QR Code that leads the user to a 3D Viewer when scanned
<plattar-embed init="viewer" />
  • server (optional)

The backend server to target for the embedded Scene. This must be one of production, staging or dev. This attribute is optional and default value is production.

<plattar-embed server="production" />