@roomle/embedding-lib 4.24.0 → 4.25.0-alpha.1

package/docs/api/interfaces/types.UiInitData.md

@@ -0,0 +1,1204 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / UiInitData
+
+# Interface: UiInitData
+
+[types](../modules/types.md).UiInitData
+
+## Hierarchy
+
+- `InitDataDefinition`
+
+- `GlobalInitDataDefinition`
+
+  ↳ **`UiInitData`**
+
+## Table of contents
+
+### Properties
+
+- [\_measureTraffic](types.UiInitData.md#_measuretraffic)
+- [addOnSpots](types.UiInitData.md#addonspots)
+- [alwaysUseCache](types.UiInitData.md#alwaysusecache)
+- [api](types.UiInitData.md#api)
+- [applyCurrentGlobalParameters](types.UiInitData.md#applycurrentglobalparameters)
+- [autoQuality](types.UiInitData.md#autoquality)
+- [bananaForScale](types.UiInitData.md#bananaforscale)
+- [buttons](types.UiInitData.md#buttons)
+- [cameraRestriction](types.UiInitData.md#camerarestriction)
+- [cameraSpacing](types.UiInitData.md#cameraspacing)
+- [colors](types.UiInitData.md#colors)
+- [configuratorId](types.UiInitData.md#configuratorid)
+- [customApiUrl](types.UiInitData.md#customapiurl)
+- [debug](types.UiInitData.md#debug)
+- [deeplink](types.UiInitData.md#deeplink)
+- [disableEnvMap](types.UiInitData.md#disableenvmap)
+- [dls](types.UiInitData.md#dls)
+- [edit](types.UiInitData.md#edit)
+- [emails](types.UiInitData.md#emails)
+- [featureFlags](types.UiInitData.md#featureflags)
+- [floorMaterialsTag](types.UiInitData.md#floormaterialstag)
+- [gaConsent](types.UiInitData.md#gaconsent)
+- [groupPartList](types.UiInitData.md#grouppartlist)
+- [id](types.UiInitData.md#id)
+- [initialFloorMaterial](types.UiInitData.md#initialfloormaterial)
+- [isItem](types.UiInitData.md#isitem)
+- [locale](types.UiInitData.md#locale)
+- [ls](types.UiInitData.md#ls)
+- [maxHorizontalCameraAngle](types.UiInitData.md#maxhorizontalcameraangle)
+- [maxVerticalCameraAngle](types.UiInitData.md#maxverticalcameraangle)
+- [meshSelection](types.UiInitData.md#meshselection)
+- [minHorizontalCameraAngle](types.UiInitData.md#minhorizontalcameraangle)
+- [minVerticalCameraAngle](types.UiInitData.md#minverticalcameraangle)
+- [mobileLandscape](types.UiInitData.md#mobilelandscape)
+- [moc](types.UiInitData.md#moc)
+- [mode](types.UiInitData.md#mode)
+- [offlineSync](types.UiInitData.md#offlinesync)
+- [offset](types.UiInitData.md#offset)
+- [overrideCountry](types.UiInitData.md#overridecountry)
+- [overrideRapi](types.UiInitData.md#overriderapi)
+- [overrideServerUrl](types.UiInitData.md#overrideserverurl)
+- [overrideTenant](types.UiInitData.md#overridetenant)
+- [plusInPreview](types.UiInitData.md#plusinpreview)
+- [precisionCm](types.UiInitData.md#precisioncm)
+- [precisionInch](types.UiInitData.md#precisioninch)
+- [preloadHint](types.UiInitData.md#preloadhint)
+- [preloadId](types.UiInitData.md#preloadid)
+- [shareUrl](types.UiInitData.md#shareurl)
+- [showArButton](types.UiInitData.md#showarbutton)
+- [showInfos](types.UiInitData.md#showinfos)
+- [showPrice](types.UiInitData.md#showprice)
+- [skin](types.UiInitData.md#skin)
+- [startTag](types.UiInitData.md#starttag)
+- [stats](types.UiInitData.md#stats)
+- [translations](types.UiInitData.md#translations)
+- [transparentHighlighting](types.UiInitData.md#transparenthighlighting)
+- [typeChangeTag](types.UiInitData.md#typechangetag)
+- [unit](types.UiInitData.md#unit)
+- [unitStringType](types.UiInitData.md#unitstringtype)
+- [useLocalRoomle](types.UiInitData.md#uselocalroomle)
+- [usePriceService](types.UiInitData.md#usepriceservice)
+- [useRoomlePrice](types.UiInitData.md#useroomleprice)
+- [variants](types.UiInitData.md#variants)
+- [zIndex](types.UiInitData.md#zindex)
+- [zoomDistance](types.UiInitData.md#zoomdistance)
+
+## Properties
+
+### \_measureTraffic
+
+• `Optional` **\_measureTraffic**: false \| true
+
+**`internal`**
+Enable service worker which tracks performance and request size (content, materials, etc)
+
+#### Inherited from
+
+InitDataDefinition.\_measureTraffic
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:165
+
+___
+
+### addOnSpots
+
+• `Optional` **addOnSpots**: false \| true
+
+**`deprecated`**
+If set to true we are showing plus icon where addons can be added.
+This has to be scripted. For more information ask your Roomle contact.
+
+#### Inherited from
+
+InitDataDefinition.addOnSpots
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:194
+
+___
+
+### alwaysUseCache
+
+• `Optional` **alwaysUseCache**: false \| true
+
+when set to true and assets were prechaced by the asset loader they are returned from cache. Otherwise we always return a fresh copy from network
+usage: alwaysUseCache=true
+default: not set -> assets fetched from url, set -> assets from cache
+
+#### Inherited from
+
+GlobalInitDataDefinition.alwaysUseCache
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:48
+
+___
+
+### api
+
+• `Optional` **api**: false \| true
+
+if set to true you can load the configurator in an iframe.src but without any embedding lib
+This is needed if you do not want to interact with the configurator and only want to use it
+to view 3d content. Imagine it then as a <img> tag for 3d content
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:86](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L86)
+
+___
+
+### applyCurrentGlobalParameters
+
+• `Optional` **applyCurrentGlobalParameters**: false \| true
+
+set this flag to false and global parameters are not applied when switching variants
+default: true
+
+#### Overrides
+
+InitDataDefinition.applyCurrentGlobalParameters
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:133](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L133)
+
+___
+
+### autoQuality
+
+• `Optional` **autoQuality**: false \| true
+
+If set to true the configurator will make sure every device has great user experience  with fluid frame rate.
+If set to false the configurator will always show the highest quality possible.
+That could lead to stutter and other problems on low-end devices. We advise you to only turn off "autoQuality" if you really know what you are doing.
+default: true
+usage: autoQuality=false
+
+#### Inherited from
+
+InitDataDefinition.autoQuality
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:66
+
+___
+
+### bananaForScale
+
+• `Optional` **bananaForScale**: false \| true
+
+Easter Egg
+
+#### Inherited from
+
+InitDataDefinition.bananaForScale
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:253
+
+___
+
+### buttons
+
+• `Optional` **buttons**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `addons?` | false \| true |
+| `ar?` | false \| true |
+| `dimensions?` | false \| true |
+| `export3d?` | false \| true |
+| `fullscreen?` | false \| true |
+| `multiselect?` | false \| true |
+| `partlist?` | false \| true |
+| `pauseconfigure?` | false \| true |
+| `redo?` | false \| true |
+| `renderimage?` | false \| true |
+| `requestproduct?` | false \| true |
+| `resetcamera?` | false \| true |
+| `savedraft?` | false \| true |
+| `snapping?` | false \| true |
+| `startconfigure?` | false \| true |
+| `undo?` | false \| true |
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:38](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L38)
+
+___
+
+### cameraRestriction
+
+• `Optional` **cameraRestriction**: `number`
+
+When set this param restricts the camera rotation to the given angle (e.g. 45 degree), this overrides minHorizontalCameraAngle and maxHorizontalCameraAngle
+default: not set -> no camera restriction
+usage: cameraRestriction=45
+
+#### Inherited from
+
+InitDataDefinition.cameraRestriction
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:227
+
+___
+
+### cameraSpacing
+
+• `Optional` **cameraSpacing**: `number`
+
+Adds the given spacing (in centimeters) to the loaded object. This is then used to calculate the initial camera distance
+default: object size itself
+usage: cameraSpacing=100
+
+#### Inherited from
+
+InitDataDefinition.cameraSpacing
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:279
+
+___
+
+### colors
+
+• `Optional` **colors**: `Object`
+
+Can be used to personalize colors used in the 3D scene
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `DEFAULT_BACKGROUND` | `string` |
+| `ON_PRIMARY` | `string` |
+| `PRIMARY` | `string` |
+| `SELECTION` | `string` |
+
+#### Inherited from
+
+InitDataDefinition.colors
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:68
+
+___
+
+### configuratorId
+
+• `Optional` **configuratorId**: `string`
+
+The id which should be used for this configurator instance.
+When this id is set all InitData parameter can be set and changed in Rubens Admin.
+This is the way we recommend to set init data params.
+Ask your Roomle contact for your configuratorId.
+
+#### Inherited from
+
+GlobalInitDataDefinition.configuratorId
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:42
+
+___
+
+### customApiUrl
+
+• `Optional` **customApiUrl**: `string`
+
+Set which RAPI (Roomle API) backend should be used
+usage: customApiUrl=https://www.roomle.com/api/v2
+
+#### Inherited from
+
+GlobalInitDataDefinition.customApiUrl
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:53
+
+___
+
+### debug
+
+• `Optional` **debug**: false \| true
+
+This flag enables:
+- Scripter debug logs (e.g. which parameter is not assigned to a parameter group)
+- Free camera movement (no restrictions, camera stays after reload, panning using Shift key)
+
+#### Inherited from
+
+InitDataDefinition.debug
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:171
+
+___
+
+### deeplink
+
+• `Optional` **deeplink**: `string`
+
+Set this parameter to use your custom share url.
+The provided url has to contain a configuration id parameter (`#CONFIGURATIONID#`) which will be replaced with the real
+configuration id.
+default: not set -> use Roomle short url service (linking to roomle.com domain)
+usage: http://www.example.com/configurator?id=#CONFIGURATIONID#
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:73](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L73)
+
+___
+
+### disableEnvMap
+
+• `Optional` **disableEnvMap**: false \| true
+
+**`internal`**
+If set to true, it will disable the environment map completely
+
+#### Inherited from
+
+InitDataDefinition.disableEnvMap
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:181
+
+___
+
+### dls
+
+• `Optional` **dls**: `string`
+
+**`internal`**
+Load a light setting using an URL.
+Check lights in {@link SceneSettings} for an example.
+
+#### Inherited from
+
+InitDataDefinition.dls
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:210
+
+___
+
+### edit
+
+• `Optional` **edit**: false \| true
+
+**`internal`**
+If set to true the plan can be edited.
+
+#### Inherited from
+
+InitDataDefinition.edit
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:298
+
+___
+
+### emails
+
+• `Optional` **emails**: false \| true
+
+if this is set to true the "save draft" will be done by sending
+an e-mail
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:91](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L91)
+
+___
+
+### featureFlags
+
+• `Optional` **featureFlags**: `FeatureFlags`
+
+**`internal`**
+this is an object which is for Roomle internal usage, we can set feature flags
+so that we can ensure a smooth transition between different versions of our configurator
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:107](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L107)
+
+___
+
+### floorMaterialsTag
+
+• `Optional` **floorMaterialsTag**: `string`
+
+**`deprecated`**
+
+#### Inherited from
+
+InitDataDefinition.floorMaterialsTag
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:215
+
+___
+
+### gaConsent
+
+• `Optional` **gaConsent**: false \| true
+
+set this flag to false if the user did not give the consent to Analytics
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:111](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L111)
+
+___
+
+### groupPartList
+
+• `Optional` **groupPartList**: false \| true
+
+set this flag to true if you want to group the part list by main components
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:101](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L101)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+The item id or configuration id of the item which should be loaded.
+Examples:
+Configuration id: usm:frame:2449773A7F54278EBB61A67A10EF6A10E8BB6F38BE775B028AC050B438414507
+Item id: usm:frame
+
+#### Inherited from
+
+InitDataDefinition.id
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:81
+
+___
+
+### initialFloorMaterial
+
+• `Optional` **initialFloorMaterial**: `string`
+
+Set the floor material which is used when loading the configurator
+For different options see {@link EnvironmentSetting}
+
+#### Inherited from
+
+InitDataDefinition.initialFloorMaterial
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:204
+
+___
+
+### isItem
+
+• `Optional` **isItem**: false \| true
+
+**`deprecated`**
+Set if the currently loaded id is an item or a configuration.
+In the new configurator UI this is determined automatically based on the id.
+
+#### Inherited from
+
+InitDataDefinition.isItem
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:74
+
+___
+
+### locale
+
+• `Optional` **locale**: `string`
+
+Set the language/locale which should be used, for example 'de' or 'en'
+
+#### Inherited from
+
+GlobalInitDataDefinition.locale
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:16
+
+___
+
+### ls
+
+• `Optional` **ls**: `string`
+
+#### Inherited from
+
+InitDataDefinition.ls
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:211
+
+___
+
+### maxHorizontalCameraAngle
+
+• `Optional` **maxHorizontalCameraAngle**: `number`
+
+When set this param restricts the right/horizontal camera rotation to the given angle (e.g. 45 degree)
+default: not set -> no camera angle restriction
+usage: maxHorizontalCameraAngle=45
+
+#### Inherited from
+
+InitDataDefinition.maxHorizontalCameraAngle
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:251
+
+___
+
+### maxVerticalCameraAngle
+
+• `Optional` **maxVerticalCameraAngle**: `number`
+
+When set this param restricts the up/vertical camera rotation to the given angle (e.g. 45 degree)
+default: not set -> no camera angle restriction
+usage: maxVerticalCameraAngle=45
+
+#### Inherited from
+
+InitDataDefinition.maxVerticalCameraAngle
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:239
+
+___
+
+### meshSelection
+
+• `Optional` **meshSelection**: false \| true
+
+ When mesh selection is enabled, the meshes of the object are used directly for highlighting.
+ Setting it to false could be useful for square/rectangular (shelf) items.
+
+#### Inherited from
+
+InitDataDefinition.meshSelection
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:158
+
+___
+
+### minHorizontalCameraAngle
+
+• `Optional` **minHorizontalCameraAngle**: `number`
+
+When set this param restricts the left/horizontal camera rotation to the given angle (e.g. 45 degree)
+default: not set -> no camera angle restriction
+usage: minHorizontalCameraAngle=45
+
+#### Inherited from
+
+InitDataDefinition.minHorizontalCameraAngle
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:245
+
+___
+
+### minVerticalCameraAngle
+
+• `Optional` **minVerticalCameraAngle**: `number`
+
+When set this param restricts the down/vertical camera rotation to the given angle (e.g. 45 degree)
+default: not set -> no camera angle restriction
+usage: minVerticalCameraAngle=45
+
+#### Inherited from
+
+InitDataDefinition.minVerticalCameraAngle
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:233
+
+___
+
+### mobileLandscape
+
+• `Optional` **mobileLandscape**: false \| true
+
+set this flag to true if you want to configure on small devices in landscape as well
+this is relevant for things like Rubens Admin, where the configurator is embedded into a very
+small div
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:97](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L97)
+
+___
+
+### moc
+
+• `Optional` **moc**: false \| true
+
+If set to true it will treat the planner as a multi object configurator (moc).
+This means:
+ - do not merge geometries
+ - set configurator environment & lights in planner
+ - reduce initial spacing of camera (higher zoom)
+
+#### Inherited from
+
+InitDataDefinition.moc
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:306
+
+___
+
+### mode
+
+• `Optional` **mode**: `CAMERA_2D` \| `CAMERA_3D` \| `CAMERA_FP`
+
+Select with which camera mode to start initially.
+default: 3D
+usage: mode=2D
+options: 2D, 3D, FP
+
+#### Inherited from
+
+InitDataDefinition.mode
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:293
+
+___
+
+### offlineSync
+
+• `Optional` **offlineSync**: `string`
+
+**`deprecated`**
+Download all necessary files to run the configurator in offline mode
+
+#### Inherited from
+
+InitDataDefinition.offlineSync
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:188
+
+___
+
+### offset
+
+• `Optional` **offset**: `CanvasOffset`
+
+**`deprecated`**
+Change the offset of the camera. For example if you add a margin left (0.1 means 10%) then
+the item moves to the right.
+This value is overridden in the new configurator UI.
+
+#### Inherited from
+
+InitDataDefinition.offset
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:148
+
+___
+
+### overrideCountry
+
+• `Optional` **overrideCountry**: `string`
+
+Set country to use for the Roomle price service.
+If not used the customer IP address will be used to determine the location.
+usage: overrideCountry=de
+
+#### Inherited from
+
+GlobalInitDataDefinition.overrideCountry
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:29
+
+___
+
+### overrideRapi
+
+• `Optional` **overrideRapi**: ``"live"`` \| ``"test"``
+
+**`internal`**
+Set which RAPI (Roomle API) backend should be used
+options: live, test
+
+#### Inherited from
+
+GlobalInitDataDefinition.overrideRapi
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:35
+
+___
+
+### overrideServerUrl
+
+• `Optional` **overrideServerUrl**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:59](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L59)
+
+___
+
+### overrideTenant
+
+• `Optional` **overrideTenant**: `number`
+
+**`internal`**
+
+**`deprecated`**
+Can be used for content testing
+default: 9
+
+#### Inherited from
+
+GlobalInitDataDefinition.overrideTenant
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:23
+
+___
+
+### plusInPreview
+
+• `Optional` **plusInPreview**: false \| true
+
+**`deprecated`**
+If set to true we show a plus in the addon preview boxes.
+
+#### Inherited from
+
+InitDataDefinition.plusInPreview
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:199
+
+___
+
+### precisionCm
+
+• `Optional` **precisionCm**: `string`
+
+Set how many positions after the decimal point should be shown.
+For example:
+123,45 -> precisionCm=2 -> 123,45
+123,45 -> precisionCm=1 -> 123,5
+123,45 -> precisionCm=0 -> 124
+
+#### Inherited from
+
+InitDataDefinition.precisionCm
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:118
+
+___
+
+### precisionInch
+
+• `Optional` **precisionInch**: `string`
+
+Set how many positions after the decimal point should be shown.
+For example:
+8' 1.68" -> precisionCm=2 -> 8' 1.68"
+8' 1.68" -> precisionCm=1 -> 8' 1.7"
+8' 1.68" -> precisionCm=0 -> 8' 2"
+
+#### Inherited from
+
+InitDataDefinition.precisionInch
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:110
+
+___
+
+### preloadHint
+
+• `Optional` **preloadHint**: `string`
+
+**`deprecated`**
+
+**`internal`**
+Same as preloadId, both call getPreloadForItem or getPreloadForConfiguration to pre load things needed
+for the configuration so that there are less XHR calls and the cache is pre-warmed
+Will no longer be used in the new configurator UI.
+
+#### Inherited from
+
+InitDataDefinition.preloadHint
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:141
+
+___
+
+### preloadId
+
+• `Optional` **preloadId**: `string`
+
+**`deprecated`**
+
+**`internal`**
+Same as preloadHint, both call getPreloadForItem or getPreloadForConfiguration to pre load things needed
+for the configuration so that there are less XHR calls and the cache is pre-warmed
+Will no longer be used in the new configurator UI.
+
+#### Inherited from
+
+InitDataDefinition.preloadId
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:89
+
+___
+
+### shareUrl
+
+• `Optional` **shareUrl**: `string`
+
+**`deprecated`**
+for details see deeplink, the only change is that the placeholder is <CONF_ID> here instead of #CONFIGURATIONID#
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:64](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L64)
+
+___
+
+### showArButton
+
+• `Optional` **showArButton**: false \| true
+
+**`deprecated`**
+Set if the AR button should be shown.
+In the new configurator UI this is in the configurator settings object called buttons.
+
+#### Inherited from
+
+InitDataDefinition.showArButton
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:95
+
+___
+
+### showInfos
+
+• `Optional` **showInfos**: false \| true
+
+**`deprecated`**
+Shows partlist if there are no prices
+
+#### Inherited from
+
+InitDataDefinition.showInfos
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:264
+
+___
+
+### showPrice
+
+• `Optional` **showPrice**: false \| true
+
+**`deprecated`**
+Show price label using prices from configuration script
+
+#### Inherited from
+
+InitDataDefinition.showPrice
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:269
+
+___
+
+### skin
+
+• `Optional` **skin**: [`EmbeddingSkin`](types.EmbeddingSkin.md)
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:56](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L56)
+
+___
+
+### startTag
+
+• `Optional` **startTag**: `string`
+
+**`deprecated`**
+Add a tag id which is used to show different variations when opening the configurator
+
+#### Inherited from
+
+InitDataDefinition.startTag
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:153
+
+___
+
+### stats
+
+• `Optional` **stats**: false \| true
+
+if set to true it shows a little overlay with performance stats
+
+#### Inherited from
+
+InitDataDefinition.stats
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:160
+
+___
+
+### translations
+
+• `Optional` **translations**: `any`
+
+override translations to change labels for some or all languages.
+Example:
+
+```
+  "translations": {
+    "en": {
+      "params": {
+        "request-product": "Add to cart",
+      }
+    }
+  }
+```
+
+You can find all labels here: [Base.json](../../../ui/base.json)
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:128](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L128)
+
+___
+
+### transparentHighlighting
+
+• `Optional` **transparentHighlighting**: false \| true
+
+If set to true, components which are between the camera and the selected component/preview will be rendered transparent
+default: false
+usage: transparentHighlighting=true
+
+#### Inherited from
+
+InitDataDefinition.transparentHighlighting
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:259
+
+___
+
+### typeChangeTag
+
+• `Optional` **typeChangeTag**: `string`
+
+Add a tag id which is used to show different variations for the current item/configuration
+
+#### Inherited from
+
+InitDataDefinition.typeChangeTag
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:133
+
+___
+
+### unit
+
+• `Optional` **unit**: `string`
+
+Defines which unit should be used for measurements/dimensions
+Options: 'cm', 'mm', 'inchfeet'
+
+#### Inherited from
+
+InitDataDefinition.unit
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:123
+
+___
+
+### unitStringType
+
+• `Optional` **unitStringType**: `string`
+
+How the current unit should be formatted
+Options:
+'none': No unit string added, for example '200'
+'long': Long unit string, for example '200 meters'
+'short': Short unit string, for example '200 m'
+
+#### Inherited from
+
+InitDataDefinition.unitStringType
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:131
+
+___
+
+### useLocalRoomle
+
+• `Optional` **useLocalRoomle**: false \| true
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:58](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L58)
+
+___
+
+### usePriceService
+
+• `Optional` **usePriceService**: false \| true
+
+If set to true, prices are calculated using the Roomle price service.
+For more information ask your Roomle contact.
+
+#### Inherited from
+
+InitDataDefinition.usePriceService
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:176
+
+___
+
+### useRoomlePrice
+
+• `Optional` **useRoomlePrice**: false \| true
+
+**`internal`**
+
+**`deprecated`**
+Use prices which are hardcoded in the configuration script.
+Only used for trade show demos.
+
+#### Inherited from
+
+InitDataDefinition.useRoomlePrice
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:102
+
+___
+
+### variants
+
+• `Optional` **variants**: [`VariantsMap`](types.VariantsMap.md)
+
+Define to which variants you can switch from which root component id. This is a simple JS object which is
+used like a map, e.g.: { "usm:frame": "DB_Start_ohne_Element" } now if a configuration with root component
+usm:frame is loaded all the items from the tag "DB_Start_ohne_Element" are now shown as variants
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:80](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L80)
+
+___
+
+### zIndex
+
+• `Optional` **zIndex**: `number`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:57](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L57)
+
+___
+
+### zoomDistance
+
+• `Optional` **zoomDistance**: `number`
+
+Set the distance to which the user can zoom (in centimeters).
+default: object size divided by 10 or 10 cm
+usage: zoomDistance=3
+
+#### Inherited from
+
+InitDataDefinition.zoomDistance
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:221