# RoomleConfiguratorApi.default

[Embedding API Reference](/rubens/rubens-products/rubens-products-reference.md) / [Modules](/rubens/rubens-products/rubens-products-reference/modules.md) / [roomle-configurator-api](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md) / default

## Class: default\<SdkType, SdkCallbacks>

[roomle-configurator-api](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md).default

### Type parameters

| Name           |
| -------------- |
| `SdkType`      |
| `SdkCallbacks` |

### Implements

* [`RoomleEmbeddingApiKeys`](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md)

### Table of contents

#### Properties

* [analytics](#analytics)
* [extended](#extended)
* [global](#global)
* [ui](#ui)

#### Methods

* [teardown](#teardown)
* [create](#create)
* [createConfigurator](#createconfigurator)
* [createPlanner](#createplanner)
* [createViewer](#createviewer)

### Properties

#### analytics

• **analytics**: `Object`

**Type declaration**

| Name        | Type                                                                                                                                              |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callbacks` | [`ExposedAnalyticsCallbacks`](/rubens/rubens-products/rubens-products-reference/classes/exposed_analytics_callbacks.exposedanalyticscallbacks.md) |

**Implementation of**

[RoomleEmbeddingApiKeys](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[analytics](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md#analytics)

***

#### extended

• **extended**: `SdkType`

**Implementation of**

[RoomleEmbeddingApiKeys](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[extended](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md#extended)

***

#### global

• **global**: `Object`

**Type declaration**

| Name        | Type             |
| ----------- | ---------------- |
| `callbacks` | `GlobalCallback` |

**Implementation of**

[RoomleEmbeddingApiKeys](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[global](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md#global)

***

#### ui

• **ui**: [`ExposedApi`](/rubens/rubens-products/rubens-products-reference/classes/exposed_api.exposedapi.md)

**Implementation of**

[RoomleEmbeddingApiKeys](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[ui](/rubens/rubens-products/rubens-products-reference/interfaces/roomle_configurator_api.roomleembeddingapikeys.md#ui)

### Methods

#### teardown

▸ **teardown**(): `void`

**Returns**

`void`

***

#### create

▸ **create**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleconfiguratorapi)>

Method to create a new instance of a Roomle Configurator

**Parameters**

| Name             | Type                                                                                             | Description                                                                                     |
| ---------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| `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`       | [`UiInitData`](/rubens/rubens-products/rubens-products-reference/interfaces/types.uiinitdata.md) | settings with which the configurator should be started                                          |

**Returns**

`Promise`<[`RoomleConfiguratorApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleconfiguratorapi)>

**`Deprecated`**

please use "createConfigurator"

***

#### createConfigurator

▸ **createConfigurator**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleconfiguratorapi)>

Method to create a new instance of a Roomle Configurator

**Parameters**

| Name             | Type                                                                                             | Description                                                                                     |
| ---------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| `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`       | [`UiInitData`](/rubens/rubens-products/rubens-products-reference/interfaces/types.uiinitdata.md) | settings with which the configurator should be started                                          |

**Returns**

`Promise`<[`RoomleConfiguratorApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleconfiguratorapi)>

***

#### createPlanner

▸ **createPlanner**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomlePlannerApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleplannerapi)>

**Parameters**

| Name             | Type                                                                                             |
| ---------------- | ------------------------------------------------------------------------------------------------ |
| `configuratorId` | `string`                                                                                         |
| `container`      | `HTMLElement`                                                                                    |
| `initData`       | [`UiInitData`](/rubens/rubens-products/rubens-products-reference/interfaces/types.uiinitdata.md) |

**Returns**

`Promise`<[`RoomlePlannerApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleplannerapi)>

***

#### createViewer

▸ **createViewer**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleViewerApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleviewerapi)>

Method to create a new instance of a Roomle Viewer

**Parameters**

| Name             | Type                                                                                             | Description                                                                                     |
| ---------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| `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`       | [`UiInitData`](/rubens/rubens-products/rubens-products-reference/interfaces/types.uiinitdata.md) | settings with which the configurator should be started                                          |

**Returns**

`Promise`<[`RoomleViewerApi`](/rubens/rubens-products/rubens-products-reference/modules/roomle_configurator_api.md#roomleviewerapi)>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.roomle.com/rubens/rubens-products/rubens-products-reference/classes/roomle_configurator_api.default.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.