@roomle/embedding-lib 4.38.0 → 4.41.0

package/docs/api/interfaces/types.UiInitData.md

@@ -43,6 +43,7 @@
 - [isItem](types.UiInitData.md#isitem)
 - [locale](types.UiInitData.md#locale)
 - [ls](types.UiInitData.md#ls)
+- [materialMultiSelect](types.UiInitData.md#materialmultiselect)
 - [maxHorizontalCameraAngle](types.UiInitData.md#maxhorizontalcameraangle)
 - [maxVerticalCameraAngle](types.UiInitData.md#maxverticalcameraangle)
 - [meshSelection](types.UiInitData.md#meshselection)
@@ -127,7 +128,7 @@ to view 3d content. Imagine it then as a <img> tag for 3d content
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:90](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L90)
+[src/configurator/embedding/types.ts:92](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L92)
 
 ___
 
@@ -144,7 +145,7 @@ InitDataDefinition.applyCurrentGlobalParameters
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:137](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L137)
+[src/configurator/embedding/types.ts:139](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L139)
 
 ___
 
@@ -209,12 +210,13 @@ ___
 | `resetcamera?` | false \| true |
 | `savedraft?` | false \| true |
 | `snapping?` | false \| true |
+| `startPlanner?` | false \| true |
 | `startconfigure?` | false \| true |
 | `undo?` | false \| true |
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:39](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L39)
+[src/configurator/embedding/types.ts:40](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L40)
 
 ___
 
@@ -345,7 +347,7 @@ usage: http://www.example.com/configurator?id=#CONFIGURATIONID#
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:77](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L77)
+[src/configurator/embedding/types.ts:79](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L79)
 
 ___
 
@@ -410,7 +412,7 @@ an e-mail
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:95](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L95)
+[src/configurator/embedding/types.ts:97](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L97)
 
 ___
 
@@ -424,7 +426,7 @@ so that we can ensure a smooth transition between different versions of our conf
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:111](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L111)
+[src/configurator/embedding/types.ts:113](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L113)
 
 ___
 
@@ -452,7 +454,7 @@ set this flag to false if the user did not give the consent to Analytics
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:115](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L115)
+[src/configurator/embedding/types.ts:117](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L117)
 
 ___
 
@@ -464,7 +466,7 @@ set this flag to true if you want to group the part list by main components
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:105](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L105)
+[src/configurator/embedding/types.ts:107](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L107)
 
 ___
 
@@ -552,6 +554,19 @@ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:20
 
 ___
 
+### materialMultiSelect
+
+• `Optional` **materialMultiSelect**: false \| true
+
+set this flag to true if you want that a user can select more than one material category at once
+default: false
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:144](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L144)
+
+___
+
 ### maxHorizontalCameraAngle
 
 • `Optional` **maxHorizontalCameraAngle**: `number`
@@ -651,7 +666,7 @@ small div
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:101](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L101)
+[src/configurator/embedding/types.ts:103](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L103)
 
 ___
 
@@ -772,7 +787,7 @@ ___
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:63](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L63)
+[src/configurator/embedding/types.ts:65](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L65)
 
 ___
 
@@ -887,7 +902,7 @@ for details see deeplink, the only change is that the placeholder is <CONF_ID> h
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:68](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L68)
+[src/configurator/embedding/types.ts:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L70)
 
 ___
 
@@ -949,7 +964,7 @@ ___
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:60](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L60)
+[src/configurator/embedding/types.ts:62](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L62)
 
 ___
 
@@ -1007,7 +1022,7 @@ You can find all labels here: [Base.json](../../../ui/base.json)
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L132)
+[src/configurator/embedding/types.ts:134](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L134)
 
 ___
 
@@ -1088,7 +1103,7 @@ ___
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:62](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L62)
+[src/configurator/embedding/types.ts:64](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L64)
 
 ___
 
@@ -1139,7 +1154,7 @@ usm:frame is loaded all the items from the tag "DB_Start_ohne_Element" are now s
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:84](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L84)
+[src/configurator/embedding/types.ts:86](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L86)
 
 ___
 
@@ -1149,7 +1164,7 @@ ___
 
 #### Defined in
 
-[src/configurator/embedding/types.ts:61](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L61)
+[src/configurator/embedding/types.ts:63](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L63)
 
 ___
 

package/docs/api/modules/roomle_configurator_api.md

@@ -26,7 +26,7 @@
 
 #### Defined in
 
-[src/configurator/embedding/roomle-configurator-api.ts:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/roomle-configurator-api.ts#L70)
+[src/configurator/embedding/roomle-configurator-api.ts:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L70)
 
 ___
 
@@ -36,7 +36,7 @@ ___
 
 #### Defined in
 
-[src/configurator/embedding/roomle-configurator-api.ts:72](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/roomle-configurator-api.ts#L72)
+[src/configurator/embedding/roomle-configurator-api.ts:72](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L72)
 
 ___
 
@@ -46,4 +46,4 @@ ___
 
 #### Defined in
 
-[src/configurator/embedding/roomle-configurator-api.ts:71](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/roomle-configurator-api.ts#L71)
+[src/configurator/embedding/roomle-configurator-api.ts:71](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L71)

package/docs/examples/11_light_settings.html

@@ -6,31 +6,36 @@
                 padding: 0;
                 overflow: hidden;
             }
+
             .ls, .product {
-              width: 70px;
-              height: 70px;
-              margin: 10px;
-              background-color:azure;
-              border: 1px solid blue;
-              color: #090909;
-              text-align: center;
-              display: flex;
-              align-items: center;
-              cursor: pointer;
+                width: 70px;
+                height: 70px;
+                margin: 10px;
+                background-color: azure;
+                border: 1px solid blue;
+                color: #090909;
+                text-align: center;
+                display: flex;
+                align-items: center;
+                cursor: pointer;
             }
+
             .product {
-              width: 70px;
-              height: 70px;
-              margin: 10px;
-              background-color:rgb(232, 254, 232);
-              border: 1px solid green;
+                width: 70px;
+                height: 70px;
+                margin: 10px;
+                background-color: rgb(232, 254, 232);
+                border: 1px solid green;
             }
+
             .ls div, .product div {
-              width: 100%;
+                width: 100%;
             }
+
             .container {
-              display: flex;
+                display: flex;
             }
+
             #configurator-container {
                 width: 1024px;
                 height: 600px;
@@ -40,60 +45,82 @@
 
     <body>
         <div class="container">
-          <div class="product" data-roomle-id="usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C"><div>Shelf</div></div>
-          <div class="product" data-roomle-id="musterring:Felicia_Sofa:7698BEE48226BBB1E0AF93F342018DC1FC269242F02D1F0C9367414A26CA3425"><div>Sofa</div></div>
-          <div class="product" data-roomle-id="hussl:ST6N:C39C46D1AD6F8BC9E3F778A6F92CB017B785CE960D8D4C7146223348A9B70590"><div>Chair</div></div>
+            <div class="product"
+                 data-roomle-id="usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C">
+                <div>Shelf</div>
+            </div>
+            <div class="product"
+                 data-roomle-id="musterring:Felicia_Sofa:7698BEE48226BBB1E0AF93F342018DC1FC269242F02D1F0C9367414A26CA3425">
+                <div>Sofa</div>
+            </div>
+            <div class="product"
+                 data-roomle-id="hussl:ST6N:C39C46D1AD6F8BC9E3F778A6F92CB017B785CE960D8D4C7146223348A9B70590">
+                <div>Chair</div>
+            </div>
         </div>
         <div class="container">
-          <div class="ls" data-roomle-ls="sofa"><div>Sofa<br>Light</div></div>
-          <div class="ls" data-roomle-ls="shelf"><div>Shelf<br>Light</div></div>
-          <div class="ls" data-roomle-ls="shelf_front"><div>Shelf Front<br>Light</div></div>
-          <div class="ls" data-roomle-ls="equal"><div>Equal<br>Light</div></div>
-          <div class="ls" data-roomle-ls="camera"><div>Camera<br>Light</div></div>
-          <div class="ls" data-roomle-ls="baked"><div>Baked<br>Light</div></div>
+            <div class="ls" data-roomle-ls="sofa">
+                <div>Sofa<br>Light</div>
+            </div>
+            <div class="ls" data-roomle-ls="shelf">
+                <div>Shelf<br>Light</div>
+            </div>
+            <div class="ls" data-roomle-ls="shelf_front">
+                <div>Shelf Front<br>Light</div>
+            </div>
+            <div class="ls" data-roomle-ls="equal">
+                <div>Equal<br>Light</div>
+            </div>
+            <div class="ls" data-roomle-ls="camera">
+                <div>Camera<br>Light</div>
+            </div>
+            <div class="ls" data-roomle-ls="baked">
+                <div>Baked<br>Light</div>
+            </div>
         </div>
         <div id="configurator-container"></div>
         <script src="./roomle-configurator-api.es.min.js" type="module"></script>
         <script type="module">
-            import RoomleConfiguratorApi from './roomle-configurator-api.es.min.js';
-            (async ()=> {
-                const options = {
-                    id: 'usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C'
-                };
-                const configurator = await RoomleConfiguratorApi.createConfigurator(
-                    'demoConfigurator',
-                    document.getElementById('configurator-container'),
-                    options,
-                );
+          import RoomleConfiguratorApi from './roomle-configurator-api.es.min.js';
+
+          (async () => {
+            const options = {
+              id: 'usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C',
+            };
+            const configurator = await RoomleConfiguratorApi.createConfigurator(
+              'demoConfigurator',
+              document.getElementById('configurator-container'),
+              options,
+            );
 
-                [...document.querySelectorAll('.ls')].forEach((button) => {
-                  button.addEventListener('click', (productDomNode) => {
-                    const target = productDomNode.target;
-                    let roomleLs = target.getAttribute('data-roomle-ls') || target.parentElement.getAttribute('data-roomle-ls');
-                    if(!roomleLs) {
-                      return;
-                    }
-                    // this is obfuscated on purpose because it uses internal API functions
-                    // which are not meant to be used! This example should only demonstrate
-                    // the different light settings. Sure it's easy to decode the string but
-                    // please do not copy and paste the decoded code into your production app
-                    // unless you know what you do :-)
-                    eval(atob('Y29uZmlndXJhdG9yLmV4dGVuZGVkLmxvYWREeW5hbWljTGlnaHRTZXR0aW5nKHtsczogcm9vbWxlTHN9KQ=='));
-                  });
-                });
+            [...document.querySelectorAll('.ls')].forEach((button) => {
+              button.addEventListener('click', (productDomNode) => {
+                const target = productDomNode.target;
+                let roomleLs = target.getAttribute('data-roomle-ls') || target.parentElement.getAttribute('data-roomle-ls');
+                if (!roomleLs) {
+                  return;
+                }
+                // this is obfuscated on purpose because it uses internal API functions
+                // which are not meant to be used! This example should only demonstrate
+                // the different light settings. Sure it's easy to decode the string but
+                // please do not copy and paste the decoded code into your production app
+                // unless you know what you do :-)
+                eval(atob('Y29uZmlndXJhdG9yLmV4dGVuZGVkLmxvYWREeW5hbWljTGlnaHRTZXR0aW5nKHtsczogcm9vbWxlTHN9KQ=='));
+              });
+            });
 
-                [...document.querySelectorAll('.product')].forEach((button) => {
-                  button.addEventListener('click', (productDomNode) => {
-                    const target = productDomNode.target;
-                    let roomleId = target.getAttribute('data-roomle-id') || target.parentElement.getAttribute('data-roomle-id');
-                    if(!roomleId) {
-                      return;
-                    }
-                    configurator.ui.loadObject(roomleId);
-                  });
-                });
-            })();
+            [...document.querySelectorAll('.product')].forEach((button) => {
+              button.addEventListener('click', (productDomNode) => {
+                const target = productDomNode.target;
                 let roomleId = target.getAttribute('data-roomle-id') || target.parentElement.getAttribute('data-roomle-id');
+                if (!roomleId) {
+                  return;
+                }
+                configurator.ui.loadObject(roomleId);
+              });
+            });
+          })();
+          let roomleId = target.getAttribute('data-roomle-id') || target.parentElement.getAttribute('data-roomle-id');
         </script>
     </body>
 </html>