# UtilsShims.InitDataDefinition

[common-core/src/utils/shims](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/common_core_src_utils_shims).InitDataDefinition

Init data parameter which can be used in configurator AND planner

## Hierarchy

* [`CommonInitData`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata)
* [`ConfiguratorInitData`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata)
* [`PlannerInitData`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.plannerinitdata)

  ↳ **`InitDataDefinition`**

## Table of contents

### Properties

* [animateCamera](#animatecamera)
* [applyCurrentGlobalParameters](#applycurrentglobalparameters)
* [autoQuality](#autoquality)
* [cameraRestriction](#camerarestriction)
* [cameraSpacing](#cameraspacing)
* [colors](#colors)
* [customShading](#customshading)
* [customShadingMoc](#customshadingmoc)
* [debug](#debug)
* [debugGeometry](#debuggeometry)
* [envMapIntensity](#envmapintensity)
* [envMapRotation](#envmaprotation)
* [envMapUrl](#envmapurl)
* [floorMaterialsTag](#floormaterialstag)
* [highlighting](#highlighting)
* [horizontalCameraAngle](#horizontalcameraangle)
* [id](#id)
* [initialFloorMaterial](#initialfloormaterial)
* [isItem](#isitem)
* [legacyLight](#legacylight)
* [linearAoFilter](#linearaofilter)
* [ls](#ls)
* [maxHorizontalCameraAngle](#maxhorizontalcameraangle)
* [maxLightSources](#maxlightsources)
* [maxVerticalCameraAngle](#maxverticalcameraangle)
* [meshSelection](#meshselection)
* [minHorizontalCameraAngle](#minhorizontalcameraangle)
* [minVerticalCameraAngle](#minverticalcameraangle)
* [mode](#mode)
* [offlineSync](#offlinesync)
* [offset](#offset)
* [precisionCm](#precisioncm)
* [precisionInch](#precisioninch)
* [restrictionLevel](#restrictionlevel)
* [sceneLight](#scenelight)
* [shading](#shading)
* [showArButton](#showarbutton)
* [showInfos](#showinfos)
* [showPrice](#showprice)
* [startTag](#starttag)
* [stats](#stats)
* [transparentBackground](#transparentbackground)
* [transparentHighlighting](#transparenthighlighting)
* [typeChangeTag](#typechangetag)
* [unit](#unit)
* [unitStringType](#unitstringtype)
* [usePriceService](#usepriceservice)
* [verticalCameraAngle](#verticalcameraangle)
* [zoomDistance](#zoomdistance)

## Properties

### animateCamera

• `Optional` **animateCamera**: `boolean`

**`Description`**

If set to false the camera will just jump to a new position\
default: true\
usage: animateCamera=false

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[animateCamera](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#animatecamera)

***

### applyCurrentGlobalParameters

• `Optional` **applyCurrentGlobalParameters**: `boolean`

**`Description`**

If set to true it will try to apply all current global parameters to the loaded object

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[applyCurrentGlobalParameters](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#applycurrentglobalparameters)

***

### autoQuality

• `Optional` **autoQuality**: `boolean`

**`Description`**

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.\
usage: autoQuality=false

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[autoQuality](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#autoquality)

***

### cameraRestriction

• `Optional` **cameraRestriction**: `number`

**`Description`**

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

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[cameraRestriction](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#camerarestriction)

***

### cameraSpacing

• `Optional` **cameraSpacing**: `number`

**`Description`**

Adds the given spacing (in centimeters) to the loaded object. This is then used to calculate the initial camera distance\
default: 0\
usage:\
cameraSpacing=100, zoom out further by increasing camera spacing by 100 centimeters\
cameraSpacing=-30, zoom in further by decreasing camera spacing by 30 centimeters

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[cameraSpacing](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#cameraspacing)

***

### colors

• `Optional` **colors**: [`ColorsIn3dScene`](https://docs.roomle.com/rubens/rubens-sdk/modules/common_core_src_utils_shims#colorsin3dscene)

**`Description`**

Can be used to personalize colors used in the 3D scene

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[colors](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#colors)

***

### customShading

• `Optional` **customShading**: [`CustomShadingParameters`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.customshadingparameters)

**`Description`**

Customized shading properties for the overall appearance

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[customShading](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#customshading)

***

### customShadingMoc

• `Optional` **customShadingMoc**: [`CustomShadingParameters`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.customshadingparameters)

**`Description`**

Customized shading properties for the overall appearance in MOC

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[customShadingMoc](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#customshadingmoc)

***

### debug

• `Optional` **debug**: `boolean`

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[debug](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#debug)

***

### debugGeometry

• `Optional` **debugGeometry**: `boolean`

**`Description`**

This flag enables:

* External object docking vector debug geometry

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[debugGeometry](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#debuggeometry)

***

### envMapIntensity

• `Optional` **envMapIntensity**: `number`

**`Description`**

Set the intensity of the environment map

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[envMapIntensity](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#envmapintensity)

***

### envMapRotation

• `Optional` **envMapRotation**: `number`

**`Description`**

Set the rotation of the environment map in radians, between 0 and 2 \* PI, rotates counter-clockwise

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[envMapRotation](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#envmaprotation)

***

### envMapUrl

• `Optional` **envMapUrl**: `string`

**`Description`**

Url to an exr or hdr env map

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[envMapUrl](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#envmapurl)

***

### floorMaterialsTag

• `Optional` **floorMaterialsTag**: `string`

**`Deprecated`**

**`Description`**

define which floors to load

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[floorMaterialsTag](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#floormaterialstag)

***

### highlighting

• `Optional` **highlighting**: `string`

**`Description`**

Sets the behavior of the highlighting of a hovered component.\
usage: highlighting=smart

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[highlighting](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#highlighting)

***

### horizontalCameraAngle

• `Optional` **horizontalCameraAngle**: `number`

**`Description`**

Sets the default/initial horizontal camera angle (yaw)\
default: -30\
usage: horizontalCameraAngle=45

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[horizontalCameraAngle](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#horizontalcameraangle)

***

### id

• `Optional` **id**: `string`

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[id](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#id)

***

### initialFloorMaterial

• `Optional` **initialFloorMaterial**: `string`

**`Description`**

Set the floor material which is used when loading the configurator\
For different options see [@roomle/web-sdk/configurator-core/src/environment/dynamic-environment-setting-loader#EnvironmentSetting](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/common_core_src_utils_shims)

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[initialFloorMaterial](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#initialfloormaterial)

***

### isItem

• `Optional` **isItem**: `boolean`

**`Deprecated`**

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[isItem](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#isitem)

***

### legacyLight

• `Optional` **legacyLight**: `boolean`

**`Description`**

Use old light setting instead of env maps

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[legacyLight](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#legacylight)

***

### linearAoFilter

• `Optional` **linearAoFilter**: `boolean`

**`Description`**

Activates the linear AO filter mode to reduce AO anti-aliasing artifacts

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[linearAoFilter](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#linearaofilter)

***

### ls

• `Optional` **ls**: `string`

**`Description`**

Load a predefined light setting, eg: ls=sofa

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[ls](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#ls)

***

### maxHorizontalCameraAngle

• `Optional` **maxHorizontalCameraAngle**: `number`

**`Description`**

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

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[maxHorizontalCameraAngle](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#maxhorizontalcameraangle)

***

### maxLightSources

• `Optional` **maxLightSources**: `number`

**`Description`**

Set the maximum number of light sources extracted from the environment map

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[maxLightSources](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#maxlightsources)

***

### maxVerticalCameraAngle

• `Optional` **maxVerticalCameraAngle**: `number`

**`Description`**

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

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[maxVerticalCameraAngle](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#maxverticalcameraangle)

***

### meshSelection

• `Optional` **meshSelection**: `boolean`

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[meshSelection](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#meshselection)

***

### minHorizontalCameraAngle

• `Optional` **minHorizontalCameraAngle**: `number`

**`Description`**

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

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[minHorizontalCameraAngle](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#minhorizontalcameraangle)

***

### minVerticalCameraAngle

• `Optional` **minVerticalCameraAngle**: `number`

**`Description`**

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

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[minVerticalCameraAngle](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#minverticalcameraangle)

***

### mode

• `Optional` **mode**: [`Enumify`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_configurator._internal_#enumify)<{ `CAMERA_2D`: `"2D"` = '2D'; `CAMERA_3D`: `"3D"` = '3D'; `CAMERA_FP`: `"FP"` = 'FP' }>

**`Description`**

Select with which camera mode to start initially.\
usage: mode=2D\
options: 2D, 3D, FP

#### Inherited from

[PlannerInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.plannerinitdata).[mode](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.plannerinitdata#mode)

***

### offlineSync

• `Optional` **offlineSync**: `string`

**`Deprecated`**

**`Description`**

Download all necessary files to run the configurator in offline mode

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[offlineSync](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#offlinesync)

***

### offset

• `Optional` **offset**: [`CanvasOffset`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset)

**`Deprecated`**

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[offset](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#offset)

***

### precisionCm

• `Optional` **precisionCm**: `string`

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[precisionCm](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#precisioncm)

***

### precisionInch

• `Optional` **precisionInch**: `string`

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[precisionInch](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#precisioninch)

***

### restrictionLevel

• `Optional` **restrictionLevel**: `number`

**`Description`**

restrictionLevel defines visibility of parameters and possible children

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[restrictionLevel](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#restrictionlevel)

***

### sceneLight

• `Optional` **sceneLight**: [`DefaultEnvironmentSceneType`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_configurator._internal_#defaultenvironmentscenetype)

**`Description`**

Generate environment map from a scene instead of env maps\
use all\_around for an surrounding light\
use front for a mainly frontal light

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[sceneLight](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#scenelight)

***

### shading

• `Optional` **shading**: [`SceneShadingType`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_configurator._internal_#sceneshadingtype)

**`Description`**

General shading properties for the overall appearance\
default: for planner and a configurator with colorful, metallic or wooden materials\
bright: for a configurator with white and bright materials

**`Groups`**

scene-settings

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[shading](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#shading)

***

### showArButton

• `Optional` **showArButton**: `boolean`

**`Deprecated`**

**`Description`**

Set if the AR button should be shown.\
In the new configurator UI this is in the configurator settings object called buttons.

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[showArButton](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#showarbutton)

***

### showInfos

• `Optional` **showInfos**: `boolean`

**`Deprecated`**

**`Description`**

Shows partlist if there are no prices

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[showInfos](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#showinfos)

***

### showPrice

• `Optional` **showPrice**: `boolean`

**`Deprecated`**

**`Description`**

Show price label using prices from configuration script

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[showPrice](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#showprice)

***

### startTag

• `Optional` **startTag**: `string`

**`Deprecated`**

**`Description`**

Add a tag id which is used to show different variations when opening the configurator

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[startTag](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#starttag)

***

### stats

• `Optional` **stats**: `boolean`

**`Description`**

if set to true it shows a little overlay with performance stats

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[stats](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#stats)

***

### transparentBackground

• `Optional` **transparentBackground**: `boolean`

**`Description`**

If set to true, the background is transparent and allows elements behind the configurator to be visible through the scene.\
usage: transparentBackground=true

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[transparentBackground](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#transparentbackground)

***

### transparentHighlighting

• `Optional` **transparentHighlighting**: `boolean`

**`Description`**

If set to true, components which are between the camera and the selected component/preview will be rendered transparent\
usage: transparentHighlighting=true

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[transparentHighlighting](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#transparenthighlighting)

***

### typeChangeTag

• `Optional` **typeChangeTag**: `string`

**`Description`**

Add a tag id which is used to show different variations for the current item/configuration

**`Deprecated`**

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[typeChangeTag](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#typechangetag)

***

### unit

• `Optional` **unit**: `string`

**`Description`**

Defines which unit should be used for measurements/dimensions\
Options: 'cm', 'mm', 'inchfeet'

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[unit](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#unit)

***

### unitStringType

• `Optional` **unitStringType**: `string`

**`Description`**

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

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[unitStringType](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#unitstringtype)

***

### usePriceService

• `Optional` **usePriceService**: `boolean`

**`Description`**

If set to true, prices are calculated using the Roomle price service.\
For more information ask your Roomle contact.

#### Inherited from

[CommonInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.commoninitdata).[usePriceService](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.commoninitdata#usepriceservice)

***

### verticalCameraAngle

• `Optional` **verticalCameraAngle**: `number`

**`Description`**

Sets the default/initial vertical camera angle (pitch)\
default: 10\
usage: verticalCameraAngle=45

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[verticalCameraAngle](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#verticalcameraangle)

***

### zoomDistance

• `Optional` **zoomDistance**: `number`

**`Description`**

Set the distance to which the user can zoom (in centimeters).\
default: object size divided by 10 or 10 cm\
usage: zoomDistance=3

**`Groups`**

scene-settings

#### Inherited from

[ConfiguratorInitData](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.configuratorinitdata).[zoomDistance](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/common_core_src_utils_shims.configuratorinitdata#zoomdistance)
