Properties

For the full type definitions, see Plugin API.

When written on an iframe element, property names should use lowercase kebab-case.

When written in JavaScript, they should use camelCase.

<iframe
  id="kivicubeScene"
  scene-id="7A43keFojH0v98xvFP2w52aF8Y67Zbb5"
  hide-logo
></iframe>

Boolean attributes can omit ="true".

The plugin currently accepts three formats:

• kebab-case: hide-logo
• camelCase: hideLogo
• data attributes: data-hide-logo

The docs still recommend standard HTML syntax, meaning kebab-case.

Important: properties are only read once when opening starts. After a scene or collection begins opening, changing attributes on the iframe has no effect. To reapply them, you must call openKivicubeScene() or openKivicubeCollection() again.

kivicubeIframePlugin.openKivicubeScene(iframe, {
  sceneId: "7A43keFojH0v98xvFP2w52aF8Y67Zbb5",
  hideLogo: true,
})

Watermark Note

If any property is set to a non-default value and the current domain is not authorized for plugin usage, a developer watermark will appear.

Scene Properties

sceneId

Type	Constraint	Default	Example
string	32 characters, required	none	rDM7kXvo1UJKHnQUR46s7neoCSutDul9

Specifies which scene to open.

How to get it:

1. Log in to the platform: https://cloud.kivicube.com/scenes
2. Then follow the steps shown below:

hideLogo

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to hide the logo on the scene landing page.

hideTitle

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to hide the landing-page title.

hideDownload

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to hide the asset download progress UI.

cameraPosition

Type	Constraint	Default	Example
string	front / back	back	front

Specifies which camera should be preferred when the scene first opens.

hideLoading

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to hide the default loading UI during the "load scene" stage.

hideStart

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to force-hide the "Start Now" button. When enabled, the scene enters directly after asset download completes.

Important

Force-hiding the button may cause audio and video autoplay to fail because of browser media restrictions. On some devices, it may also cause camera startup to fail.

If you only want to adjust the position or size of the Start Now Button, or overlay your own host-layer button, see getStartButtonRect() / setStartButtonRect() in Start Now Button. In most cases you do not need hideStart.

hideScan

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to hide the default scanning UI and scan guidance copy.

hideTakePhoto

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to hide the default photo button.

hideBackground

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to hide the scene background. This property is mainly meaningful for 3D scenes.

disableOpenUrl

Type	Constraint	Default	Example
boolean	optional	false	true, false

Whether to disable "open webpage" actions triggered from inside the scene. When enabled, in-scene navigation actions do not execute, but the host layer can still listen for the openUrl event and decide whether to handle navigation itself.

Collection Properties

Collections support most of the same properties as scenes. The main difference is that sceneId becomes collectionId, and collections additionally support hideGyroscopePermission and hideBackToScan.

collectionId

Type	Constraint	Default	Example
string	6 characters, required	none	b46rfc

Specifies which collection to open.

hideGyroscopePermission

Type	Constraint	Default	Example
boolean	optional	false	true, false

Supported only on collections. Hides the gyroscope permission guidance popup.

This is mainly useful when the collection does not need the gyroscope and you want to avoid requesting that permission.

hideBackToScan

Type	Constraint	Default	Example
boolean	optional	false	true, false

Supported only on collections. Hides the "Continue Scanning" button in the collection cloud recognition flow.

This is useful when you plan to provide your own "Continue Scanning" entry on the host layer.

All Other Properties Match Scene Properties

Property Differences Between Scenes and Collections

Property	Scene	Collection
sceneId	Supported	Not supported
collectionId	Not supported	Supported
hideGyroscopePermission	Not supported	Supported
hideBackToScan	Not supported	Supported

All other properties are identical.

Recommended Practices

1. Keep all properties together in the open function instead of splitting some between HTML and JavaScript.
2. Only change the properties you really need. Keeping defaults minimizes watermark and compatibility impact.
3. If you need to switch to a different sceneId or collectionId, you must close first and then reopen. Do not try to swap only the src value directly.