API ReferenceGlobalsConfiguratorInitData

# Interface: ConfiguratorInitData

# Hierarchy

# Implemented by

# Index

# Properties

# Properties

# Optional addOnSpots

addOnSpots? : boolean

Defined in packages/common-core/src/utils/shims.ts:196

deprecated If set to true we are showing plus icon where addons can be added. This has to be scripted. For more information ask your Roomle contact.


# Optional applyCurrentGlobalParameters

applyCurrentGlobalParameters? : boolean

Defined in packages/common-core/src/utils/shims.ts:275

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


# Optional bananaForScale

bananaForScale? : boolean

Defined in packages/common-core/src/utils/shims.ts:255

Easter Egg


# Optional cameraRestriction

cameraRestriction? : number

Defined in packages/common-core/src/utils/shims.ts:229

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


# Optional cameraSpacing

cameraSpacing? : number

Defined in packages/common-core/src/utils/shims.ts:281

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


# Optional dls

dls? : string

Defined in packages/common-core/src/utils/shims.ts:212

internal Load a light setting using an URL. Check lights in SceneSettings for an example.


# Optional floorMaterialsTag

floorMaterialsTag? : RapiId

Defined in packages/common-core/src/utils/shims.ts:217

deprecated


# Optional initialFloorMaterial

initialFloorMaterial? : string

Defined in packages/common-core/src/utils/shims.ts:206

Set the floor material which is used when loading the configurator For different options see EnvironmentSetting


# Optional ls

ls? : string

Defined in packages/common-core/src/utils/shims.ts:213


# Optional maxHorizontalCameraAngle

maxHorizontalCameraAngle? : number

Defined in packages/common-core/src/utils/shims.ts:253

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


# Optional maxVerticalCameraAngle

maxVerticalCameraAngle? : number

Defined in packages/common-core/src/utils/shims.ts:241

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


# Optional minHorizontalCameraAngle

minHorizontalCameraAngle? : number

Defined in packages/common-core/src/utils/shims.ts:247

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


# Optional minVerticalCameraAngle

minVerticalCameraAngle? : number

Defined in packages/common-core/src/utils/shims.ts:235

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


# Optional offlineSync

offlineSync? : string

Defined in packages/common-core/src/utils/shims.ts:190

deprecated Download all necessary files to run the configurator in offline mode


# Optional plusInPreview

plusInPreview? : boolean

Defined in packages/common-core/src/utils/shims.ts:201

deprecated If set to true we show a plus in the addon preview boxes.


# Optional showInfos

showInfos? : boolean

Defined in packages/common-core/src/utils/shims.ts:266

deprecated Shows partlist if there are no prices


# Optional showPrice

showPrice? : boolean

Defined in packages/common-core/src/utils/shims.ts:271

deprecated Show price label using prices from configuration script


# Optional transparentHighlighting

transparentHighlighting? : boolean

Defined in packages/common-core/src/utils/shims.ts:261

If set to true, components which are between the camera and the selected component/preview will be rendered transparent default: false usage: transparentHighlighting=true


# Optional zoomDistance

zoomDistance? : number

Defined in packages/common-core/src/utils/shims.ts:223

Set the distance to which the user can zoom (in centimeters). default: object size divided by 10 or 10 cm usage: zoomDistance=3