common-core/src/utils/shims.InitDataDefinition
Init data parameter which can be used in configurator AND planner
# Hierarchy
-
↳
InitDataDefinition
# Table of contents
# Properties
- applyCurrentGlobalParameters
- autoQuality
- cameraRestriction
- cameraSpacing
- colors
- customShading
- customShadingMoc
- debug
- envMapIntensity
- envMapRotation
- envMapUrl
- floorMaterialsTag
- highlighting
- id
- initialFloorMaterial
- isItem
- legacyLight
- ls
- maxHorizontalCameraAngle
- maxLightSources
- maxVerticalCameraAngle
- meshSelection
- minHorizontalCameraAngle
- minVerticalCameraAngle
- mode
- offlineSync
- offset
- precisionCm
- precisionInch
- restrictionLevel
- sceneLight
- shading
- showArButton
- showInfos
- showPrice
- startTag
- stats
- transparentBackground
- transparentHighlighting
- typeChangeTag
- unit
- unitStringType
- usePriceService
- zoomDistance
# Properties
# 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
# 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
# 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
# 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.cameraSpacing
# colors
• Optional colors: ColorsIn3dScene
Description
Can be used to personalize colors used in the 3D scene
Groups
scene-settings
# Inherited from
# customShading
• Optional customShading: CustomShadingParameters
Description
Customized shading properties for the overall appearance
Groups
scene-settings
# Inherited from
# customShadingMoc
• Optional customShadingMoc: CustomShadingParameters
Description
Customized shading properties for the overall appearance in MOC
Groups
scene-settings
# Inherited from
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
# envMapIntensity
• Optional envMapIntensity: number
Description
Set the intensity of the environment map
Groups
scene-settings
# Inherited from
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
# envMapUrl
• Optional envMapUrl: string
Description
Url to an exr or hdr env map
Groups
scene-settings
# Inherited from
# floorMaterialsTag
• Optional floorMaterialsTag: string
Deprecated
Description
define which floors to load
# Inherited from
ConfiguratorInitData.floorMaterialsTag
# highlighting
• Optional highlighting: string
Description
Sets the behavior of the highlighting of a hovered component. usage: highlighting=smart
# Inherited from
ConfiguratorInitData.highlighting
# 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
# 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
# Inherited from
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
# legacyLight
• Optional legacyLight: boolean
Description
Use old light setting instead of env maps
Groups
scene-settings
# Inherited from
# ls
• Optional ls: string
Description
Load a predefined light setting, eg: ls=sofa
Groups
scene-settings
# Inherited from
# 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
# maxLightSources
• Optional maxLightSources: number
Description
Set the maximum number of light sources extracted from the environment map
Groups
scene-settings
# Inherited from
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.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
# 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
# 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
# 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
# offlineSync
• Optional offlineSync: string
Deprecated
Description
Download all necessary files to run the configurator in offline mode
# Inherited from
ConfiguratorInitData.offlineSync
# 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
# 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
# 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
# restrictionLevel
• Optional restrictionLevel: number
Description
restrictionLevel defines visibility of parameters and possible children
# Inherited from
CommonInitData.restrictionLevel
# 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
# 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
# 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
# showInfos
• Optional showInfos: boolean
Deprecated
Description
Shows partlist if there are no prices
# Inherited from
ConfiguratorInitData.showInfos
# showPrice
• Optional showPrice: boolean
Deprecated
Description
Show price label using prices from configuration script
# Inherited from
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
# stats
• Optional stats: boolean
Description
if set to true it shows a little overlay with performance stats
# Inherited from
# 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.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.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
# unit
• Optional unit: string
Description
Defines which unit should be used for measurements/dimensions Options: 'cm', 'mm', 'inchfeet'
# Inherited from
# 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
# 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.usePriceService
# 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