UtilsShims.ConfiguratorInitData
common-core/src/utils/shims.ConfiguratorInitData
Hierarchy
ConfiguratorInitData
Table of contents
Properties
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
applyCurrentGlobalParameters
• Optional applyCurrentGlobalParameters: boolean
Description
If set to true it will try to apply all current global parameters to the loaded object
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
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
floorMaterialsTag
• Optional floorMaterialsTag: string
Deprecated
Description
define which floors to load
highlighting
• Optional highlighting: string
Description
Sets the behavior of the highlighting of a hovered component. usage: highlighting=smart
horizontalCameraAngle
• Optional horizontalCameraAngle: number
Description
Sets the default/initial horizontal camera angle (yaw) default: -30 usage: horizontalCameraAngle=45
Groups
scene-settings
initialFloorMaterial
• Optional initialFloorMaterial: string
Deprecated
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
ls
• Optional ls: string
Description
Load a predefined light setting, eg: ls=sofa
Groups
scene-settings
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
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
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
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
offlineSync
• Optional offlineSync: string
Deprecated
Description
Download all necessary files to run the configurator in offline mode
showInfos
• Optional showInfos: boolean
Deprecated
Description
Shows partlist if there are no prices
showPrice
• Optional showPrice: boolean
Deprecated
Description
Show price label using prices from configuration script
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
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
verticalCameraAngle
• Optional verticalCameraAngle: number
Description
Sets the default/initial vertical camera angle (pitch) default: 10 usage: verticalCameraAngle=45
Groups
scene-settings
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
Last updated