@roomle/embedding-lib 4.24.0 → 4.24.1-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/docs/api/.nojekyll +1 -0
  2. package/docs/api/classes/{exposed_analytics_callbacks.exposedanalyticscallbacks.md → exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md} +11 -9
  3. package/docs/api/classes/exposed_api.ExposedApi.md +227 -0
  4. package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +171 -0
  5. package/docs/api/classes/roomle_configurator_api.default.md +78 -42
  6. package/docs/api/enums/types.UI_BUTTON.md +175 -0
  7. package/docs/api/interfaces/exposed_callbacks.Labels.md +32 -0
  8. package/docs/api/interfaces/exposed_callbacks.Price.md +32 -0
  9. package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +58 -0
  10. package/docs/api/interfaces/types.ConfiguratorSettings.md +150 -0
  11. package/docs/api/interfaces/types.EmbeddingSkin.md +65 -0
  12. package/docs/api/interfaces/types.UiInitData.md +1183 -0
  13. package/docs/api/interfaces/{types.variantsmap.md → types.VariantsMap.md} +1 -1
  14. package/docs/api/modules/exposed_analytics_callbacks.md +1 -1
  15. package/docs/api/modules/exposed_api.md +1 -1
  16. package/docs/api/modules/exposed_callbacks.md +3 -3
  17. package/docs/api/modules/roomle_configurator_api.md +13 -7
  18. package/docs/api/modules/types.md +5 -5
  19. package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +8 -6
  20. package/package.json +1 -1
  21. package/roomle-configurator-api.cjs.js +1 -1
  22. package/roomle-configurator-api.cjs.min.js +1 -1
  23. package/roomle-configurator-api.es.js +1 -1
  24. package/roomle-configurator-api.es.min.js +1 -1
  25. package/roomle-configurator-api.js +1 -1
  26. package/docs/api/classes/exposed_api.exposedapi.md +0 -191
  27. package/docs/api/classes/exposed_callbacks.exposedcallbacks.md +0 -145
  28. package/docs/api/enums/types.ui_button.md +0 -145
  29. package/docs/api/interfaces/exposed_callbacks.labels.md +0 -28
  30. package/docs/api/interfaces/exposed_callbacks.price.md +0 -28
  31. package/docs/api/interfaces/roomle_configurator_api.roomleembeddingapikeys.md +0 -50
  32. package/docs/api/interfaces/types.configuratorsettings.md +0 -118
  33. package/docs/api/interfaces/types.embeddingskin.md +0 -55
  34. package/docs/api/interfaces/types.uiinitdata.md +0 -957
package/docs/api/.nojekyll ADDED
@@ -0,0 +1 @@
1
+ TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
package/docs/api/classes/{exposed_analytics_callbacks.exposedanalyticscallbacks.md → exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md} RENAMED
@@ -8,25 +8,23 @@
8
8
 
9
9
  ### Constructors
10
10
 
11
- - [constructor](exposed_analytics_callbacks.exposedanalyticscallbacks.md#constructor)
11
+ - [constructor](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md#constructor)
12
12
 
13
13
  ### Methods
14
14
 
15
- - [onGATracking](exposed_analytics_callbacks.exposedanalyticscallbacks.md#ongatracking)
15
+ - [onGATracking](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md#ongatracking)
16
16
 
17
17
  ## Constructors
18
18
 
19
19
  ### constructor
20
20
 
21
- \+ **new ExposedAnalyticsCallbacks**(): [*ExposedAnalyticsCallbacks*](exposed_analytics_callbacks.exposedanalyticscallbacks.md)
22
-
23
- **Returns:** [*ExposedAnalyticsCallbacks*](exposed_analytics_callbacks.exposedanalyticscallbacks.md)
21
+ • **new ExposedAnalyticsCallbacks**()
24
22
 
25
23
  ## Methods
26
24
 
27
25
  ### onGATracking
28
26
 
29
- ▸ **onGATracking**(...`_args`: *any*[]): *void*
27
+ ▸ **onGATracking**(...`_args`): `void`
30
28
 
31
29
  Is called whenever something is sent to google analytics
32
30
  Possible parameters are everything which is possible in gtag.js
@@ -38,8 +36,12 @@ you can intercept events and send them to your own analytics tool
38
36
 
39
37
  | Name | Type |
40
38
  | :------ | :------ |
41
- | `..._args` | *any*[] |
39
+ | `..._args` | `any`[] |
40
+
41
+ #### Returns
42
+
43
+ `void`
42
44
 
43
- **Returns:** *void*
45
+ #### Defined in
44
46
 
45
- Defined in: src/configurator/embedding/exposed-analytics-callbacks.ts:9
47
+ [src/configurator/embedding/exposed-analytics-callbacks.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-analytics-callbacks.ts#L9)
package/docs/api/classes/exposed_api.ExposedApi.md ADDED
@@ -0,0 +1,227 @@
1
+ [Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-api](../modules/exposed_api.md) / ExposedApi
2
+
3
+ # Class: ExposedApi
4
+
5
+ [exposed-api](../modules/exposed_api.md).ExposedApi
6
+
7
+ ## Table of contents
8
+
9
+ ### Constructors
10
+
11
+ - [constructor](exposed_api.ExposedApi.md#constructor)
12
+
13
+ ### Accessors
14
+
15
+ - [callbacks](exposed_api.ExposedApi.md#callbacks)
16
+
17
+ ### Methods
18
+
19
+ - [giveGaConsent](exposed_api.ExposedApi.md#givegaconsent)
20
+ - [loadConfigurationString](exposed_api.ExposedApi.md#loadconfigurationstring)
21
+ - [loadObject](exposed_api.ExposedApi.md#loadobject)
22
+ - [pauseConfiguring](exposed_api.ExposedApi.md#pauseconfiguring)
23
+ - [setPrice](exposed_api.ExposedApi.md#setprice)
24
+ - [startConfiguring](exposed_api.ExposedApi.md#startconfiguring)
25
+ - [triggerRequestPlan](exposed_api.ExposedApi.md#triggerrequestplan)
26
+ - [triggerRequestProduct](exposed_api.ExposedApi.md#triggerrequestproduct)
27
+
28
+ ## Constructors
29
+
30
+ ### constructor
31
+
32
+ • **new ExposedApi**(`sdkConnector`, `messageHandler`, `sdk`, `exposedCallbacks`, `store`, `analytics`, `globalCallback`)
33
+
34
+ #### Parameters
35
+
36
+ | Name | Type |
37
+ | :------ | :------ |
38
+ | `sdkConnector` | `SdkConnector` |
39
+ | `messageHandler` | null \| `MessageHandler` |
40
+ | `sdk` | `default` \| `default` \| `default` |
41
+ | `exposedCallbacks` | [`ExposedCallbacks`](exposed_callbacks.ExposedCallbacks.md) |
42
+ | `store` | `Store`<`StoreState`\> |
43
+ | `analytics` | `Analytics` |
44
+ | `globalCallback` | `GlobalCallback` |
45
+
46
+ #### Defined in
47
+
48
+ [src/configurator/embedding/exposed-api.ts:29](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L29)
49
+
50
+ ## Accessors
51
+
52
+ ### callbacks
53
+
54
+ • `get` **callbacks**(): [`ExposedCallbacks`](exposed_callbacks.ExposedCallbacks.md)
55
+
56
+ #### Returns
57
+
58
+ [`ExposedCallbacks`](exposed_callbacks.ExposedCallbacks.md)
59
+
60
+ #### Defined in
61
+
62
+ [src/configurator/embedding/exposed-api.ts:117](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L117)
63
+
64
+ ## Methods
65
+
66
+ ### giveGaConsent
67
+
68
+ ▸ **giveGaConsent**(): `void`
69
+
70
+ call this method if consent of Google Analytics is given later and not already in init-data on boot
71
+
72
+ #### Returns
73
+
74
+ `void`
75
+
76
+ #### Defined in
77
+
78
+ [src/configurator/embedding/exposed-api.ts:205](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L205)
79
+
80
+ ___
81
+
82
+ ### loadConfigurationString
83
+
84
+ ▸ **loadConfigurationString**(`configurationString`): `Promise`<`Nullable`<`LoadResponse`\>\>
85
+
86
+ call this method to load the configuration string you want into the 3d Scene
87
+
88
+ #### Parameters
89
+
90
+ | Name | Type | Description |
91
+ | :------ | :------ | :------ |
92
+ | `configurationString` | `string` | string of the configuration, starts with `{` and ends with `}` |
93
+
94
+ #### Returns
95
+
96
+ `Promise`<`Nullable`<`LoadResponse`\>\>
97
+
98
+ #### Defined in
99
+
100
+ [src/configurator/embedding/exposed-api.ts:136](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L136)
101
+
102
+ ___
103
+
104
+ ### loadObject
105
+
106
+ ▸ **loadObject**(`id`): `Promise`<`Nullable`<`LoadResponse`\>\>
107
+
108
+ call this method to load the object you want into the 3d Scene
109
+
110
+ #### Parameters
111
+
112
+ | Name | Type | Description |
113
+ | :------ | :------ | :------ |
114
+ | `id` | `string` | database ID of the object you want to load |
115
+
116
+ #### Returns
117
+
118
+ `Promise`<`Nullable`<`LoadResponse`\>\>
119
+
120
+ #### Defined in
121
+
122
+ [src/configurator/embedding/exposed-api.ts:125](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L125)
123
+
124
+ ___
125
+
126
+ ### pauseConfiguring
127
+
128
+ ▸ **pauseConfiguring**(): `void`
129
+
130
+ This method can be used to pause configuration
131
+ If the configurator was called in view-only mode
132
+ this method triggers the onBackToWebsite callback.
133
+ To know when the view-only mode is activated see the
134
+ description of the startConfiguring method
135
+
136
+ #### Returns
137
+
138
+ `void`
139
+
140
+ #### Defined in
141
+
142
+ [src/configurator/embedding/exposed-api.ts:173](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L173)
143
+
144
+ ___
145
+
146
+ ### setPrice
147
+
148
+ ▸ **setPrice**(`currencySymbol`, `price`): `void`
149
+
150
+ set the price for the UI to show
151
+ most likely needed when implementing your own price service
152
+
153
+ #### Parameters
154
+
155
+ | Name | Type |
156
+ | :------ | :------ |
157
+ | `currencySymbol` | `string` |
158
+ | `price` | `number` |
159
+
160
+ #### Returns
161
+
162
+ `void`
163
+
164
+ #### Defined in
165
+
166
+ [src/configurator/embedding/exposed-api.ts:150](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L150)
167
+
168
+ ___
169
+
170
+ ### startConfiguring
171
+
172
+ ▸ **startConfiguring**(): `void`
173
+
174
+ This method can be used to start configuration when
175
+ 3d scene is only initialized as viewer first, the
176
+ configurator is automatically instantiated as viewer
177
+ if the container where the configurator is placed is
178
+ smaller than 1024px (this breakpoint could change in future)
179
+ so do not rely on this exact pixel setting
180
+
181
+ #### Returns
182
+
183
+ `void`
184
+
185
+ #### Defined in
186
+
187
+ [src/configurator/embedding/exposed-api.ts:162](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L162)
188
+
189
+ ___
190
+
191
+ ### triggerRequestPlan
192
+
193
+ ▸ **triggerRequestPlan**(): `Promise`<`void`\>
194
+
195
+ call this method to trigger the onRequestPlan event from
196
+ outside of the iframe. When this method is called the same
197
+ process is kicked off as if the user would have clicked on
198
+ request plan. Therefore you can just use the same callback
199
+ to react on the response
200
+
201
+ #### Returns
202
+
203
+ `Promise`<`void`\>
204
+
205
+ #### Defined in
206
+
207
+ [src/configurator/embedding/exposed-api.ts:198](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L198)
208
+
209
+ ___
210
+
211
+ ### triggerRequestProduct
212
+
213
+ ▸ **triggerRequestProduct**(): `Promise`<`void`\>
214
+
215
+ call this method to trigger the onRequestProduct event from
216
+ outside of the iframe. When this method is called the same
217
+ process is kicked off as if the user would have clicked on
218
+ request product. Therefore you can just use the same callback
219
+ to react on the response
220
+
221
+ #### Returns
222
+
223
+ `Promise`<`void`\>
224
+
225
+ #### Defined in
226
+
227
+ [src/configurator/embedding/exposed-api.ts:187](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L187)
package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md ADDED
@@ -0,0 +1,171 @@
1
+ [Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / ExposedCallbacks
2
+
3
+ # Class: ExposedCallbacks
4
+
5
+ [exposed-callbacks](../modules/exposed_callbacks.md).ExposedCallbacks
6
+
7
+ ## Table of contents
8
+
9
+ ### Constructors
10
+
11
+ - [constructor](exposed_callbacks.ExposedCallbacks.md#constructor)
12
+
13
+ ### Methods
14
+
15
+ - [onBackToWebsite](exposed_callbacks.ExposedCallbacks.md#onbacktowebsite)
16
+ - [onButtonClicked](exposed_callbacks.ExposedCallbacks.md#onbuttonclicked)
17
+ - [onPartListUpdate](exposed_callbacks.ExposedCallbacks.md#onpartlistupdate)
18
+ - [onRequestPlan](exposed_callbacks.ExposedCallbacks.md#onrequestplan)
19
+ - [onRequestProduct](exposed_callbacks.ExposedCallbacks.md#onrequestproduct)
20
+ - [onResize](exposed_callbacks.ExposedCallbacks.md#onresize)
21
+ - [onUseFullPage](exposed_callbacks.ExposedCallbacks.md#onusefullpage)
22
+
23
+ ## Constructors
24
+
25
+ ### constructor
26
+
27
+ • **new ExposedCallbacks**()
28
+
29
+ ## Methods
30
+
31
+ ### onBackToWebsite
32
+
33
+ ▸ **onBackToWebsite**(): `void`
34
+
35
+ #### Returns
36
+
37
+ `void`
38
+
39
+ #### Defined in
40
+
41
+ [src/configurator/embedding/exposed-callbacks.ts:40](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L40)
42
+
43
+ ___
44
+
45
+ ### onButtonClicked
46
+
47
+ ▸ **onButtonClicked**(`name`): false \| true \| `void` \| `Promise`<`boolean`\>
48
+
49
+ Gets called when a button in the UI is clicked
50
+
51
+ #### Parameters
52
+
53
+ | Name | Type |
54
+ | :------ | :------ |
55
+ | `name` | [`UI_BUTTON`](../enums/types.UI_BUTTON.md) |
56
+
57
+ #### Returns
58
+
59
+ false \| true \| `void` \| `Promise`<`boolean`\>
60
+
61
+ overrideEventBehaviour true if the event has been consumed and it should not trigger default behaviour, undefined or false otherwise
62
+
63
+ #### Defined in
64
+
65
+ [src/configurator/embedding/exposed-callbacks.ts:47](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L47)
66
+
67
+ ___
68
+
69
+ ### onPartListUpdate
70
+
71
+ ▸ **onPartListUpdate**(`partList`, `hash`): `void`
72
+
73
+ fullList fullList (needed for price calculation) of the current configuration
74
+
75
+ #### Parameters
76
+
77
+ | Name | Type | Description |
78
+ | :------ | :------ | :------ |
79
+ | `partList` | `KernelPartList` | the part list with all details, grouped, etc |
80
+ | `hash` | `string` | - |
81
+
82
+ #### Returns
83
+
84
+ `void`
85
+
86
+ #### Defined in
87
+
88
+ [src/configurator/embedding/exposed-callbacks.ts:34](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L34)
89
+
90
+ ___
91
+
92
+ ### onRequestPlan
93
+
94
+ ▸ **onRequestPlan**(`planId`, `image`, `items`): `void`
95
+
96
+ #### Parameters
97
+
98
+ | Name | Type |
99
+ | :------ | :------ |
100
+ | `planId` | `string` |
101
+ | `image` | `Base64Image` |
102
+ | `items` | `any`[] |
103
+
104
+ #### Returns
105
+
106
+ `void`
107
+
108
+ #### Defined in
109
+
110
+ [src/configurator/embedding/exposed-callbacks.ts:49](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L49)
111
+
112
+ ___
113
+
114
+ ### onRequestProduct
115
+
116
+ ▸ **onRequestProduct**(`configurationId`, `image`, `partList`, `price`, `labels`, `configuration`): `void`
117
+
118
+ Returns all necessary params when 'Request Product'/'Checkout' button has pressed
119
+
120
+ #### Parameters
121
+
122
+ | Name | Type | Description |
123
+ | :------ | :------ | :------ |
124
+ | `configurationId` | `string` | id of the current configuration |
125
+ | `image` | `Base64Image` | image of the current configuration |
126
+ | `partList` | `KernelPartList` | the part list with all details, grouped, etc |
127
+ | `price` | [`Price`](../interfaces/exposed_callbacks.Price.md) | price of the current configuration, either set via setPrice or from Roomle price service |
128
+ | `labels` | [`Labels`](../interfaces/exposed_callbacks.Labels.md) | the label of the catalog and the furniture system |
129
+ | `configuration` | `RapiConfigurationEnhanced` | the data returned from the Roomle backend |
130
+
131
+ #### Returns
132
+
133
+ `void`
134
+
135
+ #### Defined in
136
+
137
+ [src/configurator/embedding/exposed-callbacks.ts:28](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L28)
138
+
139
+ ___
140
+
141
+ ### onResize
142
+
143
+ ▸ **onResize**(`isDesktop`): `void`
144
+
145
+ #### Parameters
146
+
147
+ | Name | Type |
148
+ | :------ | :------ |
149
+ | `isDesktop` | `boolean` |
150
+
151
+ #### Returns
152
+
153
+ `void`
154
+
155
+ #### Defined in
156
+
157
+ [src/configurator/embedding/exposed-callbacks.ts:36](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L36)
158
+
159
+ ___
160
+
161
+ ### onUseFullPage
162
+
163
+ ▸ **onUseFullPage**(): `void`
164
+
165
+ #### Returns
166
+
167
+ `void`
168
+
169
+ #### Defined in
170
+
171
+ [src/configurator/embedding/exposed-callbacks.ts:38](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L38)
package/docs/api/classes/roomle_configurator_api.default.md CHANGED
@@ -13,7 +13,7 @@
13
13
 
14
14
  ## Implements
15
15
 
16
- - [*RoomleEmbeddingApiKeys*](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md)
16
+ - [`RoomleEmbeddingApiKeys`](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md)
17
17
 
18
18
  ## Table of contents
19
19
 
@@ -36,69 +36,89 @@
36
36
 
37
37
  ### analytics
38
38
 
39
- • **analytics**: *object*
39
+ • **analytics**: `Object`
40
40
 
41
41
  #### Type declaration
42
42
 
43
43
  | Name | Type |
44
44
  | :------ | :------ |
45
- | `callbacks` | [*ExposedAnalyticsCallbacks*](exposed_analytics_callbacks.exposedanalyticscallbacks.md) |
45
+ | `callbacks` | [`ExposedAnalyticsCallbacks`](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md) |
46
46
 
47
- Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[analytics](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#analytics)
47
+ #### Implementation of
48
48
 
49
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:140
49
+ [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[analytics](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#analytics)
50
+
51
+ #### Defined in
52
+
53
+ [src/configurator/embedding/roomle-configurator-api.ts:140](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L140)
50
54
 
51
55
  ___
52
56
 
53
57
  ### extended
54
58
 
55
- • **extended**: SdkType
59
+ • **extended**: `SdkType`
60
+
61
+ #### Implementation of
56
62
 
57
- Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[extended](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#extended)
63
+ [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[extended](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
58
64
 
59
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:136
65
+ #### Defined in
66
+
67
+ [src/configurator/embedding/roomle-configurator-api.ts:136](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L136)
60
68
 
61
69
  ___
62
70
 
63
71
  ### global
64
72
 
65
- • **global**: *object*
73
+ • **global**: `Object`
66
74
 
67
75
  #### Type declaration
68
76
 
69
77
  | Name | Type |
70
78
  | :------ | :------ |
71
- | `callbacks` | *GlobalCallback* |
79
+ | `callbacks` | `GlobalCallback` |
80
+
81
+ #### Implementation of
72
82
 
73
- Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[global](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#global)
83
+ [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[global](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
74
84
 
75
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:144
85
+ #### Defined in
86
+
87
+ [src/configurator/embedding/roomle-configurator-api.ts:144](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L144)
76
88
 
77
89
  ___
78
90
 
79
91
  ### ui
80
92
 
81
- • **ui**: [*ExposedApi*](exposed_api.exposedapi.md)
93
+ • **ui**: [`ExposedApi`](exposed_api.ExposedApi.md)
94
+
95
+ #### Implementation of
82
96
 
83
- Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[ui](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#ui)
97
+ [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[ui](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
84
98
 
85
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:132
99
+ #### Defined in
100
+
101
+ [src/configurator/embedding/roomle-configurator-api.ts:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L132)
86
102
 
87
103
  ## Methods
88
104
 
89
105
  ### teardown
90
106
 
91
- ▸ **teardown**(): *void*
107
+ ▸ **teardown**(): `void`
108
+
109
+ #### Returns
92
110
 
93
- **Returns:** *void*
111
+ `void`
94
112
 
95
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:206
113
+ #### Defined in
114
+
115
+ [src/configurator/embedding/roomle-configurator-api.ts:206](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L206)
96
116
 
97
117
  ___
98
118
 
99
119
  ### create
100
120
 
101
- ▸ `Static` **create**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
121
+ ▸ `Static` **create**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
102
122
 
103
123
  Method to create a new instance of a Roomle Configurator
104
124
 
@@ -108,19 +128,23 @@ Method to create a new instance of a Roomle Configurator
108
128
 
109
129
  | Name | Type | Description |
110
130
  | :------ | :------ | :------ |
111
- | `configuratorId` | *string* | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
112
- | `container` | HTMLElement | DOM container in which the configurator should be placed |
113
- | `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) | settings with which the configurator should be started |
131
+ | `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
132
+ | `container` | `HTMLElement` | DOM container in which the configurator should be placed |
133
+ | `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
134
+
135
+ #### Returns
136
+
137
+ `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
114
138
 
115
- **Returns:** *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
139
+ #### Defined in
116
140
 
117
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:96
141
+ [src/configurator/embedding/roomle-configurator-api.ts:96](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L96)
118
142
 
119
143
  ___
120
144
 
121
145
  ### createConfigurator
122
146
 
123
- ▸ `Static` **createConfigurator**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
147
+ ▸ `Static` **createConfigurator**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
124
148
 
125
149
  Method to create a new instance of a Roomle Configurator
126
150
 
@@ -128,37 +152,45 @@ Method to create a new instance of a Roomle Configurator
128
152
 
129
153
  | Name | Type | Description |
130
154
  | :------ | :------ | :------ |
131
- | `configuratorId` | *string* | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
132
- | `container` | HTMLElement | DOM container in which the configurator should be placed |
133
- | `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) | settings with which the configurator should be started |
155
+ | `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
156
+ | `container` | `HTMLElement` | DOM container in which the configurator should be placed |
157
+ | `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
158
+
159
+ #### Returns
160
+
161
+ `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
134
162
 
135
- **Returns:** *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
163
+ #### Defined in
136
164
 
137
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:85
165
+ [src/configurator/embedding/roomle-configurator-api.ts:85](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L85)
138
166
 
139
167
  ___
140
168
 
141
169
  ### createPlanner
142
170
 
143
- ▸ `Static` **createPlanner**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomlePlannerApi*](../modules/roomle_configurator_api.md#roomleplannerapi)\>
171
+ ▸ `Static` **createPlanner**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
144
172
 
145
173
  #### Parameters
146
174
 
147
175
  | Name | Type |
148
176
  | :------ | :------ |
149
- | `configuratorId` | *string* |
150
- | `container` | HTMLElement |
151
- | `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) |
177
+ | `configuratorId` | `string` |
178
+ | `container` | `HTMLElement` |
179
+ | `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) |
152
180
 
153
- **Returns:** *Promise*<[*RoomlePlannerApi*](../modules/roomle_configurator_api.md#roomleplannerapi)\>
181
+ #### Returns
154
182
 
155
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:75
183
+ `Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
184
+
185
+ #### Defined in
186
+
187
+ [src/configurator/embedding/roomle-configurator-api.ts:75](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L75)
156
188
 
157
189
  ___
158
190
 
159
191
  ### createViewer
160
192
 
161
- ▸ `Static` **createViewer**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomleViewerApi*](../modules/roomle_configurator_api.md#roomleviewerapi)\>
193
+ ▸ `Static` **createViewer**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleViewerApi`](../modules/roomle_configurator_api.md#roomleviewerapi)\>
162
194
 
163
195
  Method to create a new instance of a Roomle Viewer
164
196
 
@@ -166,10 +198,14 @@ Method to create a new instance of a Roomle Viewer
166
198
 
167
199
  | Name | Type | Description |
168
200
  | :------ | :------ | :------ |
169
- | `configuratorId` | *string* | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
170
- | `container` | HTMLElement | DOM container in which the configurator should be placed |
171
- | `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) | settings with which the configurator should be started |
201
+ | `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
202
+ | `container` | `HTMLElement` | DOM container in which the configurator should be placed |
203
+ | `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
204
+
205
+ #### Returns
206
+
207
+ `Promise`<[`RoomleViewerApi`](../modules/roomle_configurator_api.md#roomleviewerapi)\>
172
208
 
173
- **Returns:** *Promise*<[*RoomleViewerApi*](../modules/roomle_configurator_api.md#roomleviewerapi)\>
209
+ #### Defined in
174
210
 
175
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:106
211
+ [src/configurator/embedding/roomle-configurator-api.ts:106](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L106)