hart-estate-widget 2.5.23 → 2.5.25
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
|
@@ -44,7 +44,7 @@ const createWidget = async (logoUrl) => {
|
|
|
44
44
|
const planId = searchParams.get("id");
|
|
45
45
|
|
|
46
46
|
const planData = await widgetApiHandler.loadWidgetData(planId);
|
|
47
|
-
const options = { // the parameters you need
|
|
47
|
+
const options = { // the parameters you need that are described below in "Parameters"
|
|
48
48
|
...planData.parsed,
|
|
49
49
|
API_URL: WIDGET_API_URL,
|
|
50
50
|
rotationMode: rotationModes.DEFAULT,
|
|
@@ -106,16 +106,18 @@ body
|
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
## Parameters:
|
|
109
|
+
Here you can see list of accessable options and example of using. There are accessable values of each option below in the block "Types of elements"
|
|
109
110
|
```js
|
|
110
111
|
{
|
|
111
112
|
// elements
|
|
112
113
|
tabs: ['rotation', 'panorama'], // included elements
|
|
113
114
|
|
|
114
115
|
// logo
|
|
115
|
-
logo: '', // path to logo
|
|
116
|
+
logo: '', // path/link to logo
|
|
116
117
|
logoUrl: '', // link opened when logo is clicked
|
|
117
118
|
|
|
118
119
|
// localization
|
|
120
|
+
// accessable languages are in "Types of elements"
|
|
119
121
|
locale: 'en', // ISO 639 language code
|
|
120
122
|
|
|
121
123
|
// width/height
|
|
@@ -124,9 +126,11 @@ body
|
|
|
124
126
|
resizable: true, // automatically resize the widget to the size of the container when the window is resized
|
|
125
127
|
|
|
126
128
|
// values
|
|
127
|
-
rotationMode: '
|
|
129
|
+
rotationMode: '', // mode of operation for plan images
|
|
128
130
|
panoramaFov: 75, // camera field of view angle for panoramic tour
|
|
129
131
|
enableCameraTransitionBetweenPanoramas: true, // enable / disable camera rotation transition between panoramas (if CameraPoint.Rotation.Yaw is defined in json)
|
|
132
|
+
instructionVisible: true, // enable / disable modal of instruction in 3D tour
|
|
133
|
+
autoRotate: false, // enable / disable auto rotation in 3D tour
|
|
130
134
|
primaryCameraPointId: null, // primary camera point id for panorama tour
|
|
131
135
|
floors: [ // array of floors, contains 360° images and panoramic tour data
|
|
132
136
|
{
|
|
@@ -144,11 +148,36 @@ body
|
|
|
144
148
|
mainText: '#HEX', // text color for buttons, elements contrasting with the main color
|
|
145
149
|
},
|
|
146
150
|
|
|
151
|
+
// copyRight: all text in widget
|
|
152
|
+
dictionaryOverrides: {
|
|
153
|
+
"create-points": "Create a point", // text for create point
|
|
154
|
+
"delete-points": "Remove point", // text for delete point
|
|
155
|
+
"research-plan": "Research plan", // text for research plan
|
|
156
|
+
"rotate-plan": "Rotate plan", // text for rotate plan
|
|
157
|
+
"ok": "Ok", // button text
|
|
158
|
+
"made-by-link": "https://getfloorplan.com/", // watermark link
|
|
159
|
+
"made-by-text": "getfloorplan.com", // watermark text
|
|
160
|
+
"instructions-hint-text": "", // additional text on the bottom of instruction modal
|
|
161
|
+
"floor": "$0 floor" // floor text
|
|
162
|
+
},
|
|
163
|
+
|
|
164
|
+
API_URL: '', // api url
|
|
165
|
+
|
|
166
|
+
// branding
|
|
167
|
+
branding: {
|
|
168
|
+
company_url: '', // link opened when logo is clicked (more priority than logoUrl)
|
|
169
|
+
company_name: '', // watermark text (more priority than dictionaryOverrides['made-by-text'])
|
|
170
|
+
widget_language: 'en', // ISO 639 language code
|
|
171
|
+
logo_path: '', // path to logo
|
|
172
|
+
|
|
147
173
|
// panorama icons
|
|
148
174
|
panoramaIcons: {
|
|
149
175
|
spot: 'URL', // icon for camera points in one room
|
|
150
176
|
door: 'URL' // icon for door
|
|
151
177
|
},
|
|
178
|
+
|
|
179
|
+
// scales
|
|
180
|
+
scales: ['x05', 'x1'],
|
|
152
181
|
}
|
|
153
182
|
|
|
154
183
|
```
|
|
@@ -174,5 +203,13 @@ floors[0].panorama.type: [
|
|
|
174
203
|
locale: [
|
|
175
204
|
'ru', // Russian language
|
|
176
205
|
'en', // English language
|
|
206
|
+
'es', // Spanish language
|
|
207
|
+
'de', // German language
|
|
208
|
+
'ja', // Japanese language
|
|
209
|
+
],
|
|
210
|
+
scales: [
|
|
211
|
+
'x1',
|
|
212
|
+
'x2',
|
|
213
|
+
'x05'
|
|
177
214
|
],
|
|
178
215
|
```
|