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

# Interface: ConfiguratorInitData

common-core/src/utils/shims.ConfiguratorInitData

# Hierarchy

ConfiguratorInitData

↳ InitDataDefinition

# Table of contents

# Properties

# applyCurrentGlobalParameters

• Optional applyCurrentGlobalParameters: boolean

Description

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

# Defined in

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

# bananaForScale

• Optional bananaForScale: boolean

Description

Easter Egg

# 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

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

# Defined in

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

# Defined in

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

# featureFlags

• Optional featureFlags: FeatureFlags

Description

features that can be enabled/disabled

# Defined in

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

# floorMaterialsTag

• Optional floorMaterialsTag: string

Deprecated

Description

define which floors to load

# 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

# Defined in

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

# Defined in

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

# ls

• Optional ls: string

Description

Load a predefined light setting, eg: ls=sofa

Groups

scene-settings

# 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

# Defined in

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

# Defined in

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

# 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

# Defined in

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

# offlineSync

• Optional offlineSync: string

Deprecated

Description

Download all necessary files to run the configurator in offline mode

# Defined in

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

# showInfos

• Optional showInfos: boolean

Deprecated

Description

Shows partlist if there are no prices

# 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

# 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

# Defined in

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

# Defined in

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

# 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

# Defined in

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