API Reference / Modules / common-core/src/utils/shims / InitDataDefinition

# Interface: InitDataDefinition

common-core/src/utils/shims.InitDataDefinition

Init data parameter which can be used in configurator AND planner

# Hierarchy

CommonInitData
ConfiguratorInitData
PlannerInitData

↳ InitDataDefinition

# Table of contents

# Properties

# _measureTraffic

• Optional _measureTraffic: boolean

Description

Enable service worker which tracks performance and request size (content, materials, etc)

# Inherited from

CommonInitData._measureTraffic

# Defined in

packages/common-core/src/utils/shims.ts:243 (opens new window)

# 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.applyCurrentGlobalParameters

# Defined in

packages/common-core/src/utils/shims.ts:444 (opens new window)

# 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.autoQuality

# Defined in

packages/common-core/src/utils/shims.ts:119 (opens new window)

# bananaForScale

• Optional bananaForScale: boolean

Description

Easter Egg

# Inherited from

ConfiguratorInitData.bananaForScale

# Defined in

packages/common-core/src/utils/shims.ts:420 (opens new window)

# 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.cameraRestriction

# Defined in

packages/common-core/src/utils/shims.ts:382 (opens new window)

# 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: object size itself usage: cameraSpacing=100

Groups

scene-settings

# Inherited from

ConfiguratorInitData.cameraSpacing

# Defined in

packages/common-core/src/utils/shims.ts:452 (opens new window)

# colors

• Optional colors: ColorsIn3dScene

Description

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

Groups

scene-settings

# Inherited from

CommonInitData.colors

# Defined in

packages/common-core/src/utils/shims.ts:125 (opens new window)

# customShading

• Optional customShading: CustomShadingParameters

Description

Customized shading properties for the overall appearance

Groups

scene-settings

# Inherited from

CommonInitData.customShading

# Defined in

packages/common-core/src/utils/shims.ts:314 (opens new window)

# customShadingMoc

• Optional customShadingMoc: CustomShadingParameters

Description

Customized shading properties for the overall appearance in MOC

Groups

scene-settings

# Inherited from

CommonInitData.customShadingMoc

# Defined in

packages/common-core/src/utils/shims.ts:320 (opens new window)

# 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.debug

# Defined in

packages/common-core/src/utils/shims.ts:250 (opens new window)

# disableEnvMap

• Optional disableEnvMap: boolean

Description

If set to true, it will disable the environment map completely

# Inherited from

CommonInitData.disableEnvMap

# Defined in

packages/common-core/src/utils/shims.ts:262 (opens new window)

# dls

• Optional dls: string

Description

Load a light setting using an URL. Check lights in @roomle/web-sdk/common-core/src/scene-settings-loader#SceneSettings for an example. value is a dynamic light setting url

# Inherited from

ConfiguratorInitData.dls

# Defined in

packages/common-core/src/utils/shims.ts:354 (opens new window)

# edit

• Optional edit: boolean

Description

If set to true the plan can be edited.

# Inherited from

PlannerInitData.edit

# Defined in

packages/common-core/src/utils/shims.ts:479 (opens new window)

# envMapIntensity

• Optional envMapIntensity: number

Description

Set the intensity of the environment map

Groups

scene-settings

# Inherited from

CommonInitData.envMapIntensity

# Defined in

packages/common-core/src/utils/shims.ts:274 (opens new window)

# 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.envMapRotation

# Defined in

packages/common-core/src/utils/shims.ts:280 (opens new window)

# envMapUrl

• Optional envMapUrl: string

Description

Url to an exr or hdr env map

Groups

scene-settings

# Inherited from

CommonInitData.envMapUrl

# Defined in

packages/common-core/src/utils/shims.ts:268 (opens new window)

# featureFlags

• Optional featureFlags: FeatureFlags

Description

features that can be enabled/disabled

# Inherited from

ConfiguratorInitData.featureFlags

# Defined in

packages/common-core/src/utils/shims.ts:464 (opens new window)

# floorMaterialsTag

• Optional floorMaterialsTag: string

Deprecated

Description

define which floors to load

# Inherited from

ConfiguratorInitData.floorMaterialsTag

# Defined in

packages/common-core/src/utils/shims.ts:366 (opens new window)

# highlighting

• Optional highlighting: string

Description

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

# Inherited from

ConfiguratorInitData.highlighting

# Defined in

packages/common-core/src/utils/shims.ts:339 (opens new window)

# 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.id

# Defined in

packages/common-core/src/utils/shims.ts:140 (opens new window)

# initialFloorMaterial

• Optional initialFloorMaterial: string

Deprecated

Description

Set the floor material which is used when loading the configurator For different options see @roomle/web-sdk/common-core/src/environment/dynamic-environment-setting-loader#EnvironmentSetting

# Inherited from

ConfiguratorInitData.initialFloorMaterial

# Defined in

packages/common-core/src/utils/shims.ts:346 (opens new window)

# 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.isItem

# Defined in

packages/common-core/src/utils/shims.ts:132 (opens new window)

# legacyLight

• Optional legacyLight: boolean

Description

Use old light setting instead of env maps

Groups

scene-settings

# Inherited from

CommonInitData.legacyLight

# Defined in

packages/common-core/src/utils/shims.ts:292 (opens new window)

# ls

• Optional ls: string

Description

Load a predefined light setting, eg: ls=sofa

Groups

scene-settings

# Inherited from

ConfiguratorInitData.ls

# Defined in

packages/common-core/src/utils/shims.ts:360 (opens new window)

# 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.maxHorizontalCameraAngle

# Defined in

packages/common-core/src/utils/shims.ts:414 (opens new window)

# maxLightSources

• Optional maxLightSources: number

Description

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

Groups

scene-settings

# Inherited from

CommonInitData.maxLightSources

# Defined in

packages/common-core/src/utils/shims.ts:286 (opens new window)

# 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.maxVerticalCameraAngle

# Defined in

packages/common-core/src/utils/shims.ts:398 (opens new window)

# 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.meshSelection

# Defined in

packages/common-core/src/utils/shims.ts:232 (opens new window)

# 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.minHorizontalCameraAngle

# Defined in

packages/common-core/src/utils/shims.ts:406 (opens new window)

# 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.minVerticalCameraAngle

# Defined in

packages/common-core/src/utils/shims.ts:390 (opens new window)

# moc

• Optional moc: boolean

Description

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

PlannerInitData.moc

# Defined in

packages/common-core/src/utils/shims.ts:489 (opens new window)

# mode

• Optional mode: 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.mode

# Defined in

packages/common-core/src/utils/shims.ts:473 (opens new window)

# offlineSync

• Optional offlineSync: string

Deprecated

Description

Download all necessary files to run the configurator in offline mode

# Inherited from

ConfiguratorInitData.offlineSync

# Defined in

packages/common-core/src/utils/shims.ts:333 (opens new window)

# offset

• Optional offset: 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.offset

# Defined in

packages/common-core/src/utils/shims.ts:220 (opens new window)

# 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.precisionCm

# Defined in

packages/common-core/src/utils/shims.ts:182 (opens new window)

# 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.precisionInch

# Defined in

packages/common-core/src/utils/shims.ts:173 (opens new window)

# preloadHint

• Optional preloadHint: string

Deprecated

Description

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

CommonInitData.preloadHint

# Defined in

packages/common-core/src/utils/shims.ts:212 (opens new window)

# preloadId

• Optional preloadId: string

Deprecated

Description

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

CommonInitData.preloadId

# Defined in

packages/common-core/src/utils/shims.ts:149 (opens new window)

# restrictionLevel

• Optional restrictionLevel: number

Description

restrictionLevel defines visibility of parameters and possible children

# Inherited from

CommonInitData.restrictionLevel

# Defined in

packages/common-core/src/utils/shims.ts:325 (opens new window)

# sceneLight

• Optional sceneLight: 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.sceneLight

# Defined in

packages/common-core/src/utils/shims.ts:300 (opens new window)

# shading

• Optional shading: 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.shading

# Defined in

packages/common-core/src/utils/shims.ts:308 (opens new window)

# 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.showArButton

# Defined in

packages/common-core/src/utils/shims.ts:156 (opens new window)

# showInfos

• Optional showInfos: boolean

Deprecated

Description

Shows partlist if there are no prices

# Inherited from

ConfiguratorInitData.showInfos

# Defined in

packages/common-core/src/utils/shims.ts:433 (opens new window)

# showPrice

• Optional showPrice: boolean

Deprecated

Description

Show price label using prices from configuration script

# Inherited from

ConfiguratorInitData.showPrice

# Defined in

packages/common-core/src/utils/shims.ts:439 (opens new window)

# ssr

• Optional ssr: boolean

Description

If set to true, screen space reflections are enabled

# Inherited from

ConfiguratorInitData.ssr

# Defined in

packages/common-core/src/utils/shims.ts:458 (opens new window)

# startTag

• Optional startTag: string

Deprecated

Description

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

# Inherited from

CommonInitData.startTag

# Defined in

packages/common-core/src/utils/shims.ts:226 (opens new window)

# stats

• Optional stats: boolean

Description

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

# Inherited from

CommonInitData.stats

# Defined in

packages/common-core/src/utils/shims.ts:237 (opens new window)

# 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