hart-estate-widget 2.5.28 → 2.5.36

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/README.md CHANGED
@@ -213,3 +213,43 @@ scales: [
213
213
  'x05'
214
214
  ],
215
215
  ```
216
+
217
+ ### Widget object from the REST API
218
+ ```js
219
+ name: "", // CRM plan id (only for CRM API)
220
+ original_plan_img: "", // deprecated, path to the original plan image
221
+ original_plans_img: [ // array of paths to the original plan images
222
+ ""
223
+ ],
224
+ styled_plan_img: "", // path to the styled plan image
225
+ top_view_img: "", // path to the top view image
226
+ json: { // json with data for 3D tour
227
+ type: "furniture", // type of json (furniture, neural)
228
+ value: "" // path to json
229
+ },
230
+ panorama: { // type of panorama and paths to 360° images
231
+ type: "sphere", // 360° panorama or 'cube' for 6 images
232
+ items: {
233
+ [
234
+ camera_id: "" // camera id for panorama
235
+ room_id: "" // room id for panorama
236
+ images: [ // array of paths to 360° sphere and sides of the cube if type is cube
237
+ sphere: "",
238
+ front: null,
239
+ back: null,
240
+ left: null,
241
+ right: null,
242
+ top: null,
243
+ bottom: null,
244
+ scene_depth: "", // path to exr file for depth map if available
245
+ ]
246
+ }
247
+ ]
248
+ },
249
+ rotate: { // type of images and paths to circular view images
250
+ type: "top_down", // full model or model with cut in the middle ('middle_cut')
251
+ items: [ // array of paths to circular view images
252
+ ""
253
+ ]
254
+ }
255
+ ```