Embedding the Threekit Player

The Threekit player can be embedded in another webpage by loading it inside a div element. After loading the threekit-player.js script, call the threekitPlayer({ ... }) function, which returns a Promise to the player. Pass in the following object as a parameter:

{
  authToken,
  el,
  assetId,
  customId,
  stageId,
  cache,
  showConfigurator,
  display, 
  configurationId,
  initialConfiguration,
  showAR,
  showShare,
  showLoadingProgress,
  showLoadingThumbnail,
  onLoadingProgress,
  locale,
  allowMobileVerticalOrbit,
  compression,
  publishStage
}

Required Parameters

authToken
The public access token. Instructions for creating tokens found here.

el
The HTML element that will contain the player.

assetId
The UUID of the asset to be loaded.

customId
The custom ID of the asset to be loaded. This is set by the user in the platform. This can be used instead of the assetId parameter.

Optional Parameters

stageId (optional)
The UUID of the scene asset. Necessary when including a Model Asset within a Scene Asset when embedding the player (Scene Setup is required when using this parameter.)

cache(optional)
The caching options for the player - an object that has two key:value pairs. Integer for maxAge in milliseconds and String for scope.

showConfigurator (optional)
Determines if we render the configurator.

display: 'image' (optional)
Load 2D Player upon initialization

configurationId (optional)
Rather than providing an entire configuration object, you can initialize a default configuration based on the configuration's ID or ShortID.

initialConfiguration (optional)
An object setting up an initial configuration.

🚧
initialConfiguration
Be careful using the hasChanged conditional operator in rule logic. hasChanged is only meant to trigger when an attribute is changed, and not to be triggered on load for initialConfiguration.

showAR (optional)
Parameter to show/hide the built-in AR Button, default value is false.

showShare (optional)
Parameter to show/hide the built-in Share Button, default value is false

showLoadingThumbnail (optional)
Parameter to display a snapshot while the player is loading, default value is false

showLoadingProgress (optional)
Determines if we show the progress bar during load.

onLoadingProgress (optional)
Callback to receive loading progress information.

locale (optional)
Parameter determines the language of the embed

allowMobileVerticalOrbit (optional)
Parameter toggles vertical orbit on mobile devices, default value is false.

compression: (optional)
Override organization's compression setting for renders in 2D player.

publishStage: (optional)
'published' or 'draft'. See below for more information.

Publishing & Cache Keys

Publishing and Draft states are available in Catalog items to control what is accessible externally. Catalog Items are created as Drafts by default and can be Published when they are ready. Publishing automatically updates cache keys.

Set the publishStage embed parameter to draft or published to control what Items are accessible client-side, including sub-items of a Product configurator. If no parameter is set, no restrictions will be enforced.

Player bundle

Please note that you can embed the Threekit player at either of the following URLs:
https://${env}.threekit.com/app/js/threekit-player.js
or
https://${env}.threekit.com/app/js/threekit-player-bundle.js

It is recommended that you use the threekit-player.js script, which will load dependencies as needed. If your system has stricter security requirements and blocks requests from external systems, the bundle may be required.

Example

<div id="player"></div>
<script src="https://preview.threekit.com/app/js/threekit-player.js"></script>
<script>
     window
      .threekitPlayer({
        authToken: "01234567-89ab-cdef-0123-456789abcdef",
        el: document.getElementById("player"),
        stageId: '27b9cd7e-2bb2-4a18-b788-160743eb4b33',
        assetId: "e12a45f7-8b39-cd06-e12a-45f78b39cd06",  // you can also use { customId: CUSTOM_ID }
        initialConfiguration: {
         'Attribute Name': {
            assetId: '4a9f7980-78a4-4ace-8cda-f2799936c4dc',
            configuration: { 'key' : 'value'}
          }},
        cache: {
         maxAge: 31536000, //milliseconds
         scope: "v1.0"
        },
        showConfigurator: true,
        showAR: true,
      })
      .then(async function(player) {
        window.player = player;
      });
</script>

Upon embedding the Threekit player, ensure the source URL references the appropriate Threekit environment. For example, the script above points to preview.., thus the token and referenced assets, etc. would need to be from an instance on the preview environment.

Query Parameters

An initial configuration may be provided by setting the tkcsid query parameter to the configurations' ID or short ID. The ID and short ID for a saved configuration can be found on the Threekit platform.

http://example.com/?tkcsid=EXIPiBA56

showLoadingProgress

{
  enabled,
  waitToShow,
}

onLoadingProgress takes a callback as its value. The callback's only argument is a number, representing the progress ratio ( from 0.0 to 1.0 ). The callback will be called whenever the loading progresses. The progress ratio is only approximate.

showLoadingProgress can be either a boolean (true|false), or an object with the following properties:

enabled: determines if we show the loading bar.

waitToShow (optional): amount of time (in ms) to wait before showing the progress bar. Defaults to 500ms.

If showLoadingProgress is set to a boolean value, it will be treated as { "enabled": value }.

Compression

{
    "imageFormat": "string",
    "imageResolution": "string",
    "imageQuality": 100, // number,
    "zoomImageFormat": "string",
    "zoomImageResolution": "string",
    "zoomImageQuality": 100, // number
    "zoomImageLoadingDelay": 10, // number
}