Documentation

API Reference › Globals › ConfiguratorInitData

# Interface: ConfiguratorInitData

# Hierarchy

# Implemented by

# Index

# Properties

# Properties

# Optional applyCurrentGlobalParameters

• applyCurrentGlobalParameters? : boolean

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

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

Easter Egg

# Optional cameraRestriction

• cameraRestriction? : number

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

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

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

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

deprecated

# Optional initialFloorMaterial

• initialFloorMaterial? : string

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

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

# Optional maxHorizontalCameraAngle

• maxHorizontalCameraAngle? : number

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

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

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

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

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

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

# Optional showInfos

• showInfos? : boolean

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

deprecated Shows partlist if there are no prices

# Optional showPrice

• showPrice? : boolean

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

deprecated Show price label using prices from configuration script

# Optional transparentHighlighting

• transparentHighlighting? : boolean

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

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

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