RoomleConfiguratorApi.default
Last updated
Last updated
Embedding API Reference / Modules / roomle-configurator-api / default
roomle-configurator-api.default
Name |
---|
• analytics: Object
Type declaration
Implementation of
RoomleEmbeddingApiKeys.analytics
• extended: SdkType
Implementation of
RoomleEmbeddingApiKeys.extended
• global: Object
Type declaration
Implementation of
• ui: ExposedApi
Implementation of
▸ teardown(): void
Returns
void
▸ create(configuratorId
, container
, initData
): Promise
<RoomleConfiguratorApi
>
Method to create a new instance of a Roomle Configurator
Parameters
Returns
Promise
<RoomleConfiguratorApi
>
Deprecated
please use "createConfigurator"
▸ createConfigurator(configuratorId
, container
, initData
): Promise
<RoomleConfiguratorApi
>
Method to create a new instance of a Roomle Configurator
Parameters
Returns
Promise
<RoomleConfiguratorApi
>
▸ createPlanner(configuratorId
, container
, initData
): Promise
<RoomlePlannerApi
>
Parameters
Returns
Promise
<RoomlePlannerApi
>
▸ createViewer(configuratorId
, container
, initData
): Promise
<RoomleViewerApi
>
Method to create a new instance of a Roomle Viewer
Parameters
Returns
Promise
<RoomleViewerApi
>
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type |
---|---|
Name | Type | Description |
---|---|---|
SdkType
SdkCallbacks
callbacks
callbacks
GlobalCallback
configuratorId
string
the id which identifies your configurator, you will get this ID from your Roomle Contact Person
container
HTMLElement
DOM container in which the configurator should be placed
initData
settings with which the configurator should be started
configuratorId
string
the id which identifies your configurator, you will get this ID from your Roomle Contact Person
container
HTMLElement
DOM container in which the configurator should be placed
initData
settings with which the configurator should be started
configuratorId
string
container
HTMLElement
initData
configuratorId
string
the id which identifies your configurator, you will get this ID from your Roomle Contact Person
container
HTMLElement
DOM container in which the configurator should be placed
initData
settings with which the configurator should be started