API ReferenceGlobalsCommonInitData

# Interface: CommonInitData

Init data parameter which can be used in configurator AND planner

# Hierarchy

# Implemented by

# Index

# Properties

# Properties

# Optional _measureTraffic

_measureTraffic? : boolean

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

internal Enable service worker which tracks performance and request size (content, materials, etc)


# Optional colors

colors? : typeof ROOMLE_COLORS

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

Can be used to personalize colors used in the 3D scene


# Optional debug

debug? : boolean

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

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)

# Optional enableHD

enableHD? : boolean

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

deprecated Enable high quality rendering


# Optional id

id? : RapiId

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

The item id or configuration id of the item which should be loaded. Examples: Configuration id: usm:frame:2449773A7F54278EBB61A67A10EF6A10E8BB6F38BE775B028AC050B438414507 Item id: usm:frame


# Optional isItem

isItem? : boolean

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

deprecated 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.


# Optional meshSelection

meshSelection? : boolean

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

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.


# Optional offset

offset? : CanvasOffset

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

deprecated 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.


# Optional precisionCm

precisionCm? : string

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

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


# Optional precisionInch

precisionInch? : string

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

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"


# Optional preloadHint

preloadHint? : RapiId

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

deprecated

internal Same as preloadId, both call getPreloadForItem or getPreloadForConfiguration to pre load things needed for the configuration so that there are less XHR calls and the cache is pre-warmed Will no longer be used in the new configurator UI.


# Optional preloadId

preloadId? : RapiId

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

deprecated

internal Same as preloadHint, both call getPreloadForItem or getPreloadForConfiguration to pre load things needed for the configuration so that there are less XHR calls and the cache is pre-warmed Will no longer be used in the new configurator UI.


# Optional retina

retina? : boolean

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

deprecated Always use max resolution (device pixel ratio) available


# Optional showArButton

showArButton? : boolean

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

deprecated Set if the AR button should be shown. In the new configurator UI this is in the configurator settings object called buttons.


# Optional startTag

startTag? : RapiId

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

deprecated Add a tag id which is used to show different variations when opening the configurator


# Optional stats

stats? : boolean

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

if set to true it shows a little overlay with performance stats


# Optional typeChangeTag

typeChangeTag? : RapiId

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

Add a tag id which is used to show different variations for the current item/configuration


# Optional unit

unit? : string

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

Defines which unit should be used for measurements/dimensions Options: 'cm', 'mm', 'inchfeet'


# Optional unitStringType

unitStringType? : string

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

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'


# Optional usePriceService

usePriceService? : boolean

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

If set to true, prices are calculated using the Roomle price service. For more information ask your Roomle contact.


# Optional useRoomlePrice

useRoomlePrice? : boolean

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

internal

deprecated Use prices which are hardcoded in the configuration script. Only used for trade show demos.