@roomle/embedding-lib 4.24.0 → 4.25.0-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.
- package/docs/api/.nojekyll +1 -0
- package/docs/api/README.md +1 -1
- package/docs/api/classes/{exposed_analytics_callbacks.exposedanalyticscallbacks.md → exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md} +11 -9
- package/docs/api/classes/exposed_api.ExposedApi.md +255 -0
- package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +171 -0
- package/docs/api/classes/roomle_configurator_api.default.md +78 -42
- package/docs/api/enums/types.UI_BUTTON.md +208 -0
- package/docs/api/interfaces/exposed_callbacks.Labels.md +32 -0
- package/docs/api/interfaces/exposed_callbacks.Price.md +32 -0
- package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +58 -0
- package/docs/api/interfaces/types.ConfiguratorSettings.md +150 -0
- package/docs/api/interfaces/types.EmbeddingSkin.md +65 -0
- package/docs/api/interfaces/types.UiInitData.md +1204 -0
- package/docs/api/interfaces/{types.variantsmap.md → types.VariantsMap.md} +1 -1
- package/docs/api/modules/exposed_analytics_callbacks.md +1 -1
- package/docs/api/modules/exposed_api.md +1 -1
- package/docs/api/modules/exposed_callbacks.md +3 -3
- package/docs/api/modules/roomle_configurator_api.md +13 -7
- package/docs/api/modules/types.md +5 -5
- package/docs/index.md +31 -0
- package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +67 -7
- package/package.json +28 -1
- package/roomle-configurator-api.cjs.js +47 -3
- package/roomle-configurator-api.cjs.min.js +1 -1
- package/roomle-configurator-api.es.js +47 -3
- package/roomle-configurator-api.es.min.js +1 -1
- package/roomle-configurator-api.js +47 -3
- package/types/index.d.ts +190 -129
- package/types/src/common/store/collection-view-state.d.ts +2 -2
- package/types/src/common/store/index.d.ts +6 -0
- package/types/src/common/utils/helper.d.ts +3 -0
- package/types/src/common/utils/types.d.ts +3 -2
- package/types/src/configurator/business-logic/sdk-connector.d.ts +1 -0
- package/types/src/configurator/components/-utils/overlays.d.ts +8 -8
- package/types/src/configurator/components/grid-view/-utils/GridViewHelper.d.ts +3 -0
- package/types/src/configurator/embedding/exposed-api.d.ts +10 -0
- package/types/src/configurator/embedding/types.d.ts +7 -1
- package/types/src/configurator/store/ui-state.d.ts +19 -3
- package/types/tests/helpers/data/variants.d.ts +60 -0
- package/types/tests/helpers/mocks/sdk-connector-planner.d.ts +13 -0
- package/types/tests/helpers/mocks/sdk-connector.d.ts +5 -0
- package/types/tests/integration/configurator/components/{overlays/PartList.spec.d.ts → parameters/types/ProductVariant.spec.d.ts} +0 -0
- package/types/tests/integration/planner/components/BottomBar.spec.d.ts +1 -0
- package/docs/api/classes/exposed_api.exposedapi.md +0 -191
- package/docs/api/classes/exposed_callbacks.exposedcallbacks.md +0 -145
- package/docs/api/enums/types.ui_button.md +0 -145
- package/docs/api/interfaces/exposed_callbacks.labels.md +0 -28
- package/docs/api/interfaces/exposed_callbacks.price.md +0 -28
- package/docs/api/interfaces/roomle_configurator_api.roomleembeddingapikeys.md +0 -50
- package/docs/api/interfaces/types.configuratorsettings.md +0 -118
- package/docs/api/interfaces/types.embeddingskin.md +0 -55
- package/docs/api/interfaces/types.uiinitdata.md +0 -957
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
## Implements
|
|
15
15
|
|
|
16
|
-
- [
|
|
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**:
|
|
39
|
+
• **analytics**: `Object`
|
|
40
40
|
|
|
41
41
|
#### Type declaration
|
|
42
42
|
|
|
43
43
|
| Name | Type |
|
|
44
44
|
| :------ | :------ |
|
|
45
|
-
| `callbacks` | [
|
|
45
|
+
| `callbacks` | [`ExposedAnalyticsCallbacks`](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md) |
|
|
46
46
|
|
|
47
|
-
Implementation of
|
|
47
|
+
#### Implementation of
|
|
48
48
|
|
|
49
|
-
|
|
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/353723c4/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
|
-
|
|
63
|
+
[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[extended](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
|
|
58
64
|
|
|
59
|
-
Defined in
|
|
65
|
+
#### Defined in
|
|
66
|
+
|
|
67
|
+
[src/configurator/embedding/roomle-configurator-api.ts:136](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L136)
|
|
60
68
|
|
|
61
69
|
___
|
|
62
70
|
|
|
63
71
|
### global
|
|
64
72
|
|
|
65
|
-
• **global**:
|
|
73
|
+
• **global**: `Object`
|
|
66
74
|
|
|
67
75
|
#### Type declaration
|
|
68
76
|
|
|
69
77
|
| Name | Type |
|
|
70
78
|
| :------ | :------ |
|
|
71
|
-
| `callbacks` |
|
|
79
|
+
| `callbacks` | `GlobalCallback` |
|
|
80
|
+
|
|
81
|
+
#### Implementation of
|
|
72
82
|
|
|
73
|
-
|
|
83
|
+
[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[global](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
|
|
74
84
|
|
|
75
|
-
Defined in
|
|
85
|
+
#### Defined in
|
|
86
|
+
|
|
87
|
+
[src/configurator/embedding/roomle-configurator-api.ts:144](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L144)
|
|
76
88
|
|
|
77
89
|
___
|
|
78
90
|
|
|
79
91
|
### ui
|
|
80
92
|
|
|
81
|
-
• **ui**: [
|
|
93
|
+
• **ui**: [`ExposedApi`](exposed_api.ExposedApi.md)
|
|
94
|
+
|
|
95
|
+
#### Implementation of
|
|
82
96
|
|
|
83
|
-
|
|
97
|
+
[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[ui](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
|
|
84
98
|
|
|
85
|
-
Defined in
|
|
99
|
+
#### Defined in
|
|
100
|
+
|
|
101
|
+
[src/configurator/embedding/roomle-configurator-api.ts:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L132)
|
|
86
102
|
|
|
87
103
|
## Methods
|
|
88
104
|
|
|
89
105
|
### teardown
|
|
90
106
|
|
|
91
|
-
▸ **teardown**():
|
|
107
|
+
▸ **teardown**(): `void`
|
|
108
|
+
|
|
109
|
+
#### Returns
|
|
92
110
|
|
|
93
|
-
|
|
111
|
+
`void`
|
|
94
112
|
|
|
95
|
-
Defined in
|
|
113
|
+
#### Defined in
|
|
114
|
+
|
|
115
|
+
[src/configurator/embedding/roomle-configurator-api.ts:206](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L206)
|
|
96
116
|
|
|
97
117
|
___
|
|
98
118
|
|
|
99
119
|
### create
|
|
100
120
|
|
|
101
|
-
▸ `Static` **create**(`configuratorId
|
|
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` |
|
|
112
|
-
| `container` | HTMLElement | DOM container in which the configurator should be placed |
|
|
113
|
-
| `initData` | [
|
|
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
|
-
|
|
139
|
+
#### Defined in
|
|
116
140
|
|
|
117
|
-
|
|
141
|
+
[src/configurator/embedding/roomle-configurator-api.ts:96](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L96)
|
|
118
142
|
|
|
119
143
|
___
|
|
120
144
|
|
|
121
145
|
### createConfigurator
|
|
122
146
|
|
|
123
|
-
▸ `Static` **createConfigurator**(`configuratorId
|
|
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` |
|
|
132
|
-
| `container` | HTMLElement | DOM container in which the configurator should be placed |
|
|
133
|
-
| `initData` | [
|
|
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
|
-
|
|
163
|
+
#### Defined in
|
|
136
164
|
|
|
137
|
-
|
|
165
|
+
[src/configurator/embedding/roomle-configurator-api.ts:85](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L85)
|
|
138
166
|
|
|
139
167
|
___
|
|
140
168
|
|
|
141
169
|
### createPlanner
|
|
142
170
|
|
|
143
|
-
▸ `Static` **createPlanner**(`configuratorId
|
|
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` |
|
|
150
|
-
| `container` | HTMLElement |
|
|
151
|
-
| `initData` | [
|
|
177
|
+
| `configuratorId` | `string` |
|
|
178
|
+
| `container` | `HTMLElement` |
|
|
179
|
+
| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) |
|
|
152
180
|
|
|
153
|
-
|
|
181
|
+
#### Returns
|
|
154
182
|
|
|
155
|
-
|
|
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/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L75)
|
|
156
188
|
|
|
157
189
|
___
|
|
158
190
|
|
|
159
191
|
### createViewer
|
|
160
192
|
|
|
161
|
-
▸ `Static` **createViewer**(`configuratorId
|
|
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` |
|
|
170
|
-
| `container` | HTMLElement | DOM container in which the configurator should be placed |
|
|
171
|
-
| `initData` | [
|
|
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
|
-
|
|
209
|
+
#### Defined in
|
|
174
210
|
|
|
175
|
-
|
|
211
|
+
[src/configurator/embedding/roomle-configurator-api.ts:106](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L106)
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / UI\_BUTTON
|
|
2
|
+
|
|
3
|
+
# Enumeration: UI\_BUTTON
|
|
4
|
+
|
|
5
|
+
[types](../modules/types.md).UI_BUTTON
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Enumeration members
|
|
10
|
+
|
|
11
|
+
- [ADDONS](types.UI_BUTTON.md#addons)
|
|
12
|
+
- [AR](types.UI_BUTTON.md#ar)
|
|
13
|
+
- [DIMENSIONS](types.UI_BUTTON.md#dimensions)
|
|
14
|
+
- [EXPORT\_3D](types.UI_BUTTON.md#export_3d)
|
|
15
|
+
- [FULLSCREEN](types.UI_BUTTON.md#fullscreen)
|
|
16
|
+
- [MULTISELECT](types.UI_BUTTON.md#multiselect)
|
|
17
|
+
- [PARTLIST](types.UI_BUTTON.md#partlist)
|
|
18
|
+
- [PAUSECONFIGURE](types.UI_BUTTON.md#pauseconfigure)
|
|
19
|
+
- [REDO](types.UI_BUTTON.md#redo)
|
|
20
|
+
- [RENDERIMAGE](types.UI_BUTTON.md#renderimage)
|
|
21
|
+
- [REQUESTPLAN](types.UI_BUTTON.md#requestplan)
|
|
22
|
+
- [REQUESTPRODUCT](types.UI_BUTTON.md#requestproduct)
|
|
23
|
+
- [RESETCAMERA](types.UI_BUTTON.md#resetcamera)
|
|
24
|
+
- [ROTATE](types.UI_BUTTON.md#rotate)
|
|
25
|
+
- [SAVEDRAFT](types.UI_BUTTON.md#savedraft)
|
|
26
|
+
- [SNAPPING](types.UI_BUTTON.md#snapping)
|
|
27
|
+
- [STARTCONFIGURE](types.UI_BUTTON.md#startconfigure)
|
|
28
|
+
- [UNDO](types.UI_BUTTON.md#undo)
|
|
29
|
+
|
|
30
|
+
## Enumeration members
|
|
31
|
+
|
|
32
|
+
### ADDONS
|
|
33
|
+
|
|
34
|
+
• **ADDONS** = `"addons"`
|
|
35
|
+
|
|
36
|
+
#### Defined in
|
|
37
|
+
|
|
38
|
+
[src/configurator/embedding/types.ts:15](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L15)
|
|
39
|
+
|
|
40
|
+
___
|
|
41
|
+
|
|
42
|
+
### AR
|
|
43
|
+
|
|
44
|
+
• **AR** = `"ar"`
|
|
45
|
+
|
|
46
|
+
#### Defined in
|
|
47
|
+
|
|
48
|
+
[src/configurator/embedding/types.ts:8](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L8)
|
|
49
|
+
|
|
50
|
+
___
|
|
51
|
+
|
|
52
|
+
### DIMENSIONS
|
|
53
|
+
|
|
54
|
+
• **DIMENSIONS** = `"dimensions"`
|
|
55
|
+
|
|
56
|
+
#### Defined in
|
|
57
|
+
|
|
58
|
+
[src/configurator/embedding/types.ts:11](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L11)
|
|
59
|
+
|
|
60
|
+
___
|
|
61
|
+
|
|
62
|
+
### EXPORT\_3D
|
|
63
|
+
|
|
64
|
+
• **EXPORT\_3D** = `"export3d"`
|
|
65
|
+
|
|
66
|
+
#### Defined in
|
|
67
|
+
|
|
68
|
+
[src/configurator/embedding/types.ts:21](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L21)
|
|
69
|
+
|
|
70
|
+
___
|
|
71
|
+
|
|
72
|
+
### FULLSCREEN
|
|
73
|
+
|
|
74
|
+
• **FULLSCREEN** = `"fullscreen"`
|
|
75
|
+
|
|
76
|
+
#### Defined in
|
|
77
|
+
|
|
78
|
+
[src/configurator/embedding/types.ts:12](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L12)
|
|
79
|
+
|
|
80
|
+
___
|
|
81
|
+
|
|
82
|
+
### MULTISELECT
|
|
83
|
+
|
|
84
|
+
• **MULTISELECT** = `"multiselect"`
|
|
85
|
+
|
|
86
|
+
#### Defined in
|
|
87
|
+
|
|
88
|
+
[src/configurator/embedding/types.ts:10](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L10)
|
|
89
|
+
|
|
90
|
+
___
|
|
91
|
+
|
|
92
|
+
### PARTLIST
|
|
93
|
+
|
|
94
|
+
• **PARTLIST** = `"partlist"`
|
|
95
|
+
|
|
96
|
+
#### Defined in
|
|
97
|
+
|
|
98
|
+
[src/configurator/embedding/types.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L9)
|
|
99
|
+
|
|
100
|
+
___
|
|
101
|
+
|
|
102
|
+
### PAUSECONFIGURE
|
|
103
|
+
|
|
104
|
+
• **PAUSECONFIGURE** = `"pauseconfigure"`
|
|
105
|
+
|
|
106
|
+
#### Defined in
|
|
107
|
+
|
|
108
|
+
[src/configurator/embedding/types.ts:20](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L20)
|
|
109
|
+
|
|
110
|
+
___
|
|
111
|
+
|
|
112
|
+
### REDO
|
|
113
|
+
|
|
114
|
+
• **REDO** = `"redo"`
|
|
115
|
+
|
|
116
|
+
#### Defined in
|
|
117
|
+
|
|
118
|
+
[src/configurator/embedding/types.ts:25](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L25)
|
|
119
|
+
|
|
120
|
+
___
|
|
121
|
+
|
|
122
|
+
### RENDERIMAGE
|
|
123
|
+
|
|
124
|
+
• **RENDERIMAGE** = `"renderimage"`
|
|
125
|
+
|
|
126
|
+
#### Defined in
|
|
127
|
+
|
|
128
|
+
[src/configurator/embedding/types.ts:14](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L14)
|
|
129
|
+
|
|
130
|
+
___
|
|
131
|
+
|
|
132
|
+
### REQUESTPLAN
|
|
133
|
+
|
|
134
|
+
• **REQUESTPLAN** = `"requestplan"`
|
|
135
|
+
|
|
136
|
+
#### Defined in
|
|
137
|
+
|
|
138
|
+
[src/configurator/embedding/types.ts:17](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L17)
|
|
139
|
+
|
|
140
|
+
___
|
|
141
|
+
|
|
142
|
+
### REQUESTPRODUCT
|
|
143
|
+
|
|
144
|
+
• **REQUESTPRODUCT** = `"requestproduct"`
|
|
145
|
+
|
|
146
|
+
#### Defined in
|
|
147
|
+
|
|
148
|
+
[src/configurator/embedding/types.ts:16](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L16)
|
|
149
|
+
|
|
150
|
+
___
|
|
151
|
+
|
|
152
|
+
### RESETCAMERA
|
|
153
|
+
|
|
154
|
+
• **RESETCAMERA** = `"resetcamera"`
|
|
155
|
+
|
|
156
|
+
#### Defined in
|
|
157
|
+
|
|
158
|
+
[src/configurator/embedding/types.ts:13](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L13)
|
|
159
|
+
|
|
160
|
+
___
|
|
161
|
+
|
|
162
|
+
### ROTATE
|
|
163
|
+
|
|
164
|
+
• **ROTATE** = `"rotate"`
|
|
165
|
+
|
|
166
|
+
#### Defined in
|
|
167
|
+
|
|
168
|
+
[src/configurator/embedding/types.ts:22](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L22)
|
|
169
|
+
|
|
170
|
+
___
|
|
171
|
+
|
|
172
|
+
### SAVEDRAFT
|
|
173
|
+
|
|
174
|
+
• **SAVEDRAFT** = `"savedraft"`
|
|
175
|
+
|
|
176
|
+
#### Defined in
|
|
177
|
+
|
|
178
|
+
[src/configurator/embedding/types.ts:18](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L18)
|
|
179
|
+
|
|
180
|
+
___
|
|
181
|
+
|
|
182
|
+
### SNAPPING
|
|
183
|
+
|
|
184
|
+
• **SNAPPING** = `"snapping"`
|
|
185
|
+
|
|
186
|
+
#### Defined in
|
|
187
|
+
|
|
188
|
+
[src/configurator/embedding/types.ts:23](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L23)
|
|
189
|
+
|
|
190
|
+
___
|
|
191
|
+
|
|
192
|
+
### STARTCONFIGURE
|
|
193
|
+
|
|
194
|
+
• **STARTCONFIGURE** = `"startconfigure"`
|
|
195
|
+
|
|
196
|
+
#### Defined in
|
|
197
|
+
|
|
198
|
+
[src/configurator/embedding/types.ts:19](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L19)
|
|
199
|
+
|
|
200
|
+
___
|
|
201
|
+
|
|
202
|
+
### UNDO
|
|
203
|
+
|
|
204
|
+
• **UNDO** = `"undo"`
|
|
205
|
+
|
|
206
|
+
#### Defined in
|
|
207
|
+
|
|
208
|
+
[src/configurator/embedding/types.ts:24](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L24)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Labels
|
|
2
|
+
|
|
3
|
+
# Interface: Labels
|
|
4
|
+
|
|
5
|
+
[exposed-callbacks](../modules/exposed_callbacks.md).Labels
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Properties
|
|
10
|
+
|
|
11
|
+
- [catalogLabel](exposed_callbacks.Labels.md#cataloglabel)
|
|
12
|
+
- [label](exposed_callbacks.Labels.md#label)
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### catalogLabel
|
|
17
|
+
|
|
18
|
+
• **catalogLabel**: `Nullable`<`string`\>
|
|
19
|
+
|
|
20
|
+
#### Defined in
|
|
21
|
+
|
|
22
|
+
[src/configurator/embedding/exposed-callbacks.ts:14](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/exposed-callbacks.ts#L14)
|
|
23
|
+
|
|
24
|
+
___
|
|
25
|
+
|
|
26
|
+
### label
|
|
27
|
+
|
|
28
|
+
• **label**: `Nullable`<`string`\>
|
|
29
|
+
|
|
30
|
+
#### Defined in
|
|
31
|
+
|
|
32
|
+
[src/configurator/embedding/exposed-callbacks.ts:15](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/exposed-callbacks.ts#L15)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Price
|
|
2
|
+
|
|
3
|
+
# Interface: Price
|
|
4
|
+
|
|
5
|
+
[exposed-callbacks](../modules/exposed_callbacks.md).Price
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Properties
|
|
10
|
+
|
|
11
|
+
- [currencySymbol](exposed_callbacks.Price.md#currencysymbol)
|
|
12
|
+
- [price](exposed_callbacks.Price.md#price)
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### currencySymbol
|
|
17
|
+
|
|
18
|
+
• **currencySymbol**: `Nullable`<`string`\>
|
|
19
|
+
|
|
20
|
+
#### Defined in
|
|
21
|
+
|
|
22
|
+
[src/configurator/embedding/exposed-callbacks.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/exposed-callbacks.ts#L9)
|
|
23
|
+
|
|
24
|
+
___
|
|
25
|
+
|
|
26
|
+
### price
|
|
27
|
+
|
|
28
|
+
• **price**: `Nullable`<`number`\>
|
|
29
|
+
|
|
30
|
+
#### Defined in
|
|
31
|
+
|
|
32
|
+
[src/configurator/embedding/exposed-callbacks.ts:10](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/exposed-callbacks.ts#L10)
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
[Embedding API Reference](../README.md) / [Modules](../modules.md) / [roomle-configurator-api](../modules/roomle_configurator_api.md) / RoomleEmbeddingApiKeys
|
|
2
|
+
|
|
3
|
+
# Interface: RoomleEmbeddingApiKeys
|
|
4
|
+
|
|
5
|
+
[roomle-configurator-api](../modules/roomle_configurator_api.md).RoomleEmbeddingApiKeys
|
|
6
|
+
|
|
7
|
+
## Implemented by
|
|
8
|
+
|
|
9
|
+
- [`default`](../classes/roomle_configurator_api.default.md)
|
|
10
|
+
|
|
11
|
+
## Table of contents
|
|
12
|
+
|
|
13
|
+
### Properties
|
|
14
|
+
|
|
15
|
+
- [analytics](roomle_configurator_api.RoomleEmbeddingApiKeys.md#analytics)
|
|
16
|
+
- [extended](roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
|
|
17
|
+
- [global](roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
|
|
18
|
+
- [ui](roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
### analytics
|
|
23
|
+
|
|
24
|
+
• **analytics**: `any`
|
|
25
|
+
|
|
26
|
+
#### Defined in
|
|
27
|
+
|
|
28
|
+
[src/configurator/embedding/roomle-configurator-api.ts:65](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L65)
|
|
29
|
+
|
|
30
|
+
___
|
|
31
|
+
|
|
32
|
+
### extended
|
|
33
|
+
|
|
34
|
+
• **extended**: `any`
|
|
35
|
+
|
|
36
|
+
#### Defined in
|
|
37
|
+
|
|
38
|
+
[src/configurator/embedding/roomle-configurator-api.ts:63](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L63)
|
|
39
|
+
|
|
40
|
+
___
|
|
41
|
+
|
|
42
|
+
### global
|
|
43
|
+
|
|
44
|
+
• **global**: `any`
|
|
45
|
+
|
|
46
|
+
#### Defined in
|
|
47
|
+
|
|
48
|
+
[src/configurator/embedding/roomle-configurator-api.ts:66](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L66)
|
|
49
|
+
|
|
50
|
+
___
|
|
51
|
+
|
|
52
|
+
### ui
|
|
53
|
+
|
|
54
|
+
• **ui**: `any`
|
|
55
|
+
|
|
56
|
+
#### Defined in
|
|
57
|
+
|
|
58
|
+
[src/configurator/embedding/roomle-configurator-api.ts:64](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L64)
|