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

# Interface: CommonInitData

common-core/src/utils/shims.CommonInitData

Init data parameter which can be used in configurator AND planner

# Hierarchy

CommonInitData

↳ InitDataDefinition

# Table of contents

# Properties

# _measureTraffic

• Optional _measureTraffic: boolean

Description

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

# Defined in

packages/common-core/src/utils/shims.ts:243 (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

# Defined in

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

# colors

• Optional colors: ColorsIn3dScene

Description

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

Groups

scene-settings

# 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

# 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

# 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)

# 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

# Defined in

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

# envMapIntensity

• Optional envMapIntensity: number

Description

Set the intensity of the environment map

Groups

scene-settings

# 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

# 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

# Defined in

packages/common-core/src/utils/shims.ts:268 (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

# Defined in

packages/common-core/src/utils/shims.ts:140 (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.

# 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

# Defined in

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

# maxLightSources

• Optional maxLightSources: number

Description

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

Groups

scene-settings

# Defined in

packages/common-core/src/utils/shims.ts:286 (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.

# Defined in

packages/common-core/src/utils/shims.ts:232 (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.

# 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

# 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"

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

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

# 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

# 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

# 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