@roomle/embedding-lib 4.43.0-debug.1 → 4.44.0

package/docs/api/classes/roomle_configurator_api.default.md

@@ -0,0 +1,211 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [roomle-configurator-api](../modules/roomle_configurator_api.md) / default
+
+# Class: default<SdkType, SdkCallbacks\>
+
+[roomle-configurator-api](../modules/roomle_configurator_api.md).default
+
+## Type parameters
+
+| Name |
+| :------ |
+| `SdkType` |
+| `SdkCallbacks` |
+
+## Implements
+
+- [`RoomleEmbeddingApiKeys`](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md)
+
+## Table of contents
+
+### Properties
+
+- [analytics](roomle_configurator_api.default.md#analytics)
+- [extended](roomle_configurator_api.default.md#extended)
+- [global](roomle_configurator_api.default.md#global)
+- [ui](roomle_configurator_api.default.md#ui)
+
+### Methods
+
+- [teardown](roomle_configurator_api.default.md#teardown)
+- [create](roomle_configurator_api.default.md#create)
+- [createConfigurator](roomle_configurator_api.default.md#createconfigurator)
+- [createPlanner](roomle_configurator_api.default.md#createplanner)
+- [createViewer](roomle_configurator_api.default.md#createviewer)
+
+## Properties
+
+### analytics
+
+• **analytics**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `callbacks` | [`ExposedAnalyticsCallbacks`](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md) |
+
+#### Implementation of
+
+[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[analytics](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#analytics)
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:141](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L141)
+
+___
+
+### extended
+
+• **extended**: `SdkType`
+
+#### Implementation of
+
+[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[extended](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:137](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L137)
+
+___
+
+### global
+
+• **global**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `callbacks` | `GlobalCallback` |
+
+#### Implementation of
+
+[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[global](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:145](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L145)
+
+___
+
+### ui
+
+• **ui**: [`ExposedApi`](exposed_api.ExposedApi.md)
+
+#### Implementation of
+
+[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[ui](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:133](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L133)
+
+## Methods
+
+### teardown
+
+▸ **teardown**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:207](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L207)
+
+___
+
+### create
+
+▸ `Static` **create**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
+
+Method to create a new instance of a Roomle Configurator
+
+**`deprecated`** please use "createConfigurator"
+
+#### 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`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
+
+#### Returns
+
+`Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:97](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L97)
+
+___
+
+### createConfigurator
+
+▸ `Static` **createConfigurator**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../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`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
+
+#### Returns
+
+`Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:86](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L86)
+
+___
+
+### createPlanner
+
+▸ `Static` **createPlanner**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `configuratorId` | `string` |
+| `container` | `HTMLElement` |
+| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) |
+
+#### Returns
+
+`Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:76](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L76)
+
+___
+
+### createViewer
+
+▸ `Static` **createViewer**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleViewerApi`](../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`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
+
+#### Returns
+
+`Promise`<[`RoomleViewerApi`](../modules/roomle_configurator_api.md#roomleviewerapi)\>
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:107](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L107)

package/docs/api/enums/types.UI_BUTTON.md

@@ -0,0 +1,263 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / UI\_BUTTON
+
+# Enumeration: UI\_BUTTON
+
+[types](../modules/types.md).UI_BUTTON
+
+## Table of contents
+
+### Enumeration members
+
+- [ADDONS](types.UI_BUTTON.md#addons)
+- [ADD\_ROOM](types.UI_BUTTON.md#add_room)
+- [AR](types.UI_BUTTON.md#ar)
+- [DIMENSIONS](types.UI_BUTTON.md#dimensions)
+- [EXPORT\_3D](types.UI_BUTTON.md#export_3d)
+- [FULLSCREEN](types.UI_BUTTON.md#fullscreen)
+- [MULTISELECT](types.UI_BUTTON.md#multiselect)
+- [PARTLIST](types.UI_BUTTON.md#partlist)
+- [PARTLIST\_PLANNER](types.UI_BUTTON.md#partlist_planner)
+- [PAUSECONFIGURE](types.UI_BUTTON.md#pauseconfigure)
+- [PRODUCTLIST](types.UI_BUTTON.md#productlist)
+- [REDO](types.UI_BUTTON.md#redo)
+- [RENDERIMAGE](types.UI_BUTTON.md#renderimage)
+- [REQUESTPLAN](types.UI_BUTTON.md#requestplan)
+- [REQUESTPRODUCT](types.UI_BUTTON.md#requestproduct)
+- [RESETCAMERA](types.UI_BUTTON.md#resetcamera)
+- [ROTATE](types.UI_BUTTON.md#rotate)
+- [SAVEDRAFT](types.UI_BUTTON.md#savedraft)
+- [SNAPPING](types.UI_BUTTON.md#snapping)
+- [STARTCONFIGURE](types.UI_BUTTON.md#startconfigure)
+- [STARTPLANNER](types.UI_BUTTON.md#startplanner)
+- [TWO\_D\_VIEW](types.UI_BUTTON.md#two_d_view)
+- [UNDO](types.UI_BUTTON.md#undo)
+
+## Enumeration members
+
+### ADDONS
+
+• **ADDONS** = `"addons"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:12](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L12)
+
+___
+
+### ADD\_ROOM
+
+• **ADD\_ROOM** = `"add_room"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:26](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L26)
+
+___
+
+### AR
+
+• **AR** = `"ar"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:5](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L5)
+
+___
+
+### DIMENSIONS
+
+• **DIMENSIONS** = `"dimensions"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:8](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L8)
+
+___
+
+### EXPORT\_3D
+
+• **EXPORT\_3D** = `"export3d"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:18](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L18)
+
+___
+
+### FULLSCREEN
+
+• **FULLSCREEN** = `"fullscreen"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:9](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L9)
+
+___
+
+### MULTISELECT
+
+• **MULTISELECT** = `"multiselect"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:7](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L7)
+
+___
+
+### PARTLIST
+
+• **PARTLIST** = `"partlist"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:6](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L6)
+
+___
+
+### PARTLIST\_PLANNER
+
+• **PARTLIST\_PLANNER** = `"partlist_planner"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:23](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L23)
+
+___
+
+### PAUSECONFIGURE
+
+• **PAUSECONFIGURE** = `"pauseconfigure"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:17](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L17)
+
+___
+
+### PRODUCTLIST
+
+• **PRODUCTLIST** = `"productlist"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:24](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L24)
+
+___
+
+### REDO
+
+• **REDO** = `"redo"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:22](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L22)
+
+___
+
+### RENDERIMAGE
+
+• **RENDERIMAGE** = `"renderimage"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:11](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L11)
+
+___
+
+### REQUESTPLAN
+
+• **REQUESTPLAN** = `"requestplan"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:14](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L14)
+
+___
+
+### REQUESTPRODUCT
+
+• **REQUESTPRODUCT** = `"requestproduct"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:13](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L13)
+
+___
+
+### RESETCAMERA
+
+• **RESETCAMERA** = `"resetcamera"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:10](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L10)
+
+___
+
+### ROTATE
+
+• **ROTATE** = `"rotate"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:19](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L19)
+
+___
+
+### SAVEDRAFT
+
+• **SAVEDRAFT** = `"savedraft"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:15](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L15)
+
+___
+
+### SNAPPING
+
+• **SNAPPING** = `"snapping"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:20](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L20)
+
+___
+
+### STARTCONFIGURE
+
+• **STARTCONFIGURE** = `"startconfigure"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:16](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L16)
+
+___
+
+### STARTPLANNER
+
+• **STARTPLANNER** = `"startPlanner"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:27](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L27)
+
+___
+
+### TWO\_D\_VIEW
+
+• **TWO\_D\_VIEW** = `"2dview"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:25](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L25)
+
+___
+
+### UNDO
+
+• **UNDO** = `"undo"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:21](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/types.ts#L21)

package/docs/api/interfaces/exposed_callbacks.Labels.md

@@ -0,0 +1,32 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Labels
+
+# Interface: Labels
+
+[exposed-callbacks](../modules/exposed_callbacks.md).Labels
+
+## Table of contents
+
+### Properties
+
+- [catalogLabel](exposed_callbacks.Labels.md#cataloglabel)
+- [label](exposed_callbacks.Labels.md#label)
+
+## Properties
+
+### catalogLabel
+
+• **catalogLabel**: `Nullable`<`string`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:14](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/exposed-callbacks.ts#L14)
+
+___
+
+### label
+
+• **label**: `Nullable`<`string`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:15](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/exposed-callbacks.ts#L15)

package/docs/api/interfaces/exposed_callbacks.Price.md

@@ -0,0 +1,32 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Price
+
+# Interface: Price
+
+[exposed-callbacks](../modules/exposed_callbacks.md).Price
+
+## Table of contents
+
+### Properties
+
+- [currencySymbol](exposed_callbacks.Price.md#currencysymbol)
+- [price](exposed_callbacks.Price.md#price)
+
+## Properties
+
+### currencySymbol
+
+• **currencySymbol**: `Nullable`<`string`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:9](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/exposed-callbacks.ts#L9)
+
+___
+
+### price
+
+• **price**: `Nullable`<`number`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:10](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/exposed-callbacks.ts#L10)

package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md

@@ -0,0 +1,58 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [roomle-configurator-api](../modules/roomle_configurator_api.md) / RoomleEmbeddingApiKeys
+
+# Interface: RoomleEmbeddingApiKeys
+
+[roomle-configurator-api](../modules/roomle_configurator_api.md).RoomleEmbeddingApiKeys
+
+## Implemented by
+
+- [`default`](../classes/roomle_configurator_api.default.md)
+
+## Table of contents
+
+### Properties
+
+- [analytics](roomle_configurator_api.RoomleEmbeddingApiKeys.md#analytics)
+- [extended](roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
+- [global](roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
+- [ui](roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
+
+## Properties
+
+### analytics
+
+• **analytics**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:66](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L66)
+
+___
+
+### extended
+
+• **extended**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:64](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L64)
+
+___
+
+### global
+
+• **global**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:67](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L67)
+
+___
+
+### ui
+
+• **ui**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:65](https://github.com/roomle-dev/roomle-ui/blob/8222e2cc/src/configurator/embedding/roomle-configurator-api.ts#L65)