# Class: default
configurator-core/src/configurator.
Init data parameters which are not context specific
# Implements
# Table of contents
# Constructors
# Properties
- _creator_
- alwaysUseCache
- configuratorId
- customApiUrl
- e2e
- e2eRoomleRendererForImages
- locale
- overrideCountry
- overrideRapi
- overrideTenant
# Methods
# Constructors
# constructor
• new default(creator)
# Parameters
| Name | Type |
|---|---|
creator | string |
# Defined in
packages/common-core/src/utils/global-init-data.ts:24 (opens new window)
# Properties
# _creator_
• _creator_: string
# Implementation of
# Defined in
packages/common-core/src/utils/global-init-data.ts:11 (opens new window)
# alwaysUseCache
• Optional alwaysUseCache: boolean
Deprecated
Description
when set to true and assets were prechaced by the asset loader they are returned from cache. Otherwise we always return a fresh copy from network usage: alwaysUseCache=true default: not set -> assets fetched from url, set -> assets from cache
# Implementation of
GlobalInitDataDefinition.alwaysUseCache
# Defined in
packages/common-core/src/utils/global-init-data.ts:18 (opens new window)
# configuratorId
• Optional configuratorId: string
Description
The id which should be used for this embedding instance. When this id is set all InitData parameter can be set and changed in Rubens Admin. This is the way we recommend to set init data params. Ask your Roomle contact for your configuratorId.
# Implementation of
GlobalInitDataDefinition.configuratorId
# Defined in
packages/common-core/src/utils/global-init-data.ts:16 (opens new window)
# customApiUrl
• Optional customApiUrl: string
Description
Set which RAPI (Roomle API) backend should be used usage: customApiUrl=https://www.roomle.com/api/v2
# Implementation of
GlobalInitDataDefinition.customApiUrl
# Defined in
packages/common-core/src/utils/global-init-data.ts:19 (opens new window)
# e2e
• Optional e2e: boolean = false
Description
Can be set to true if started as an end-to-end test. This will disable post-processing
# Implementation of
# Defined in
packages/common-core/src/utils/global-init-data.ts:21 (opens new window)
# e2eRoomleRendererForImages
• Optional e2eRoomleRendererForImages: boolean = false
Description
If set to true, the Roomle Renderer is used for perspective and top images this should help the E2E tests of Joe to migrate from comparing Roomle Renderer images to Three.js Renderer images
# Implementation of
GlobalInitDataDefinition.e2eRoomleRendererForImages
# Defined in
packages/common-core/src/utils/global-init-data.ts:22 (opens new window)
# locale
• Optional locale: string
Description
locale to use for the embedding instance
# Implementation of
GlobalInitDataDefinition.locale
# Defined in
packages/common-core/src/utils/global-init-data.ts:13 (opens new window)
# overrideCountry
• Optional overrideCountry: string = null
Description
Set country to use for the Roomle price service. If not used the customer IP address will be used to determine the location. usage: overrideCountry=de
# Implementation of
GlobalInitDataDefinition.overrideCountry
# Defined in
packages/common-core/src/utils/global-init-data.ts:15 (opens new window)
# overrideRapi
• Optional overrideRapi: RapiServerUrlType
Description
Set which RAPI (Roomle API) backend should be used options: live, test
# Implementation of
GlobalInitDataDefinition.overrideRapi
# Defined in
packages/common-core/src/utils/global-init-data.ts:17 (opens new window)
# overrideTenant
• Optional overrideTenant: number
Deprecated
Description
Can be used for content testing
# Implementation of
GlobalInitDataDefinition.overrideTenant
# Defined in
packages/common-core/src/utils/global-init-data.ts:14 (opens new window)
# Methods
# setOverrides
▸ setOverrides(globalInitData): void
# Parameters
| Name | Type |
|---|---|
globalInitData | default | Partial<GlobalInitDataDefinition> |
# Returns
void
# Defined in
packages/common-core/src/utils/global-init-data.ts:28 (opens new window)