@cyclomedia/streetsmart-api 24.9.0 → 24.9.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/README.md +4 -4
- package/package.json +1 -1
- package/src/types/ObliqueViewer.d.ts +10 -0
- package/src/types/PanoramaViewer.d.ts +26 -7
package/README.md
CHANGED
|
@@ -32,7 +32,7 @@ Note the item below will just list some examples of the most frequently used met
|
|
|
32
32
|
> For all the available methods on the `StreetSmartApi` object and the individual viewer objects, please refer to the docs.
|
|
33
33
|
### Init
|
|
34
34
|
|
|
35
|
-
Please see the [official docs](https://streetsmart.cyclomedia.com/api/
|
|
35
|
+
Please see the [official docs](https://streetsmart.cyclomedia.com/api/v24.9/documentation/#init) or the `ApiOptions`
|
|
36
36
|
type for more information about the options.
|
|
37
37
|
|
|
38
38
|
```ts
|
|
@@ -57,7 +57,7 @@ await StreetSmartApi.init({
|
|
|
57
57
|
### Open viewer
|
|
58
58
|
|
|
59
59
|
After the call to `init` has successfully resolved, one or more viewers can be opened using the `open` function.
|
|
60
|
-
Please check out the [official docs](https://streetsmart.cyclomedia.com/api/
|
|
60
|
+
Please check out the [official docs](https://streetsmart.cyclomedia.com/api/v24.9/documentation/#open).
|
|
61
61
|
|
|
62
62
|
```ts
|
|
63
63
|
import { StreetSmartApi, ViewerType } from "@cyclomedia/streetsmart-api";
|
|
@@ -130,7 +130,7 @@ try {
|
|
|
130
130
|
### Destroy
|
|
131
131
|
|
|
132
132
|
For more information please refer to
|
|
133
|
-
the [official docs](https://streetsmart.cyclomedia.com/api/
|
|
133
|
+
the [official docs](https://streetsmart.cyclomedia.com/api/v24.9/documentation/#destroy)
|
|
134
134
|
|
|
135
135
|
```ts
|
|
136
136
|
import {StreetSmartApi} from "@cyclomedia/streetsmart-api";
|
|
@@ -147,5 +147,5 @@ await StreetSmartApi.destroy({
|
|
|
147
147
|
|
|
148
148
|
#### What API functions are available?
|
|
149
149
|
|
|
150
|
-
Please see the [docs](https://streetsmart.cyclomedia.com/api/
|
|
150
|
+
Please see the [docs](https://streetsmart.cyclomedia.com/api/v24.9/documentation/) for all available functions and methods.
|
|
151
151
|
|
package/package.json
CHANGED
|
@@ -116,6 +116,16 @@ declare module '@cyclomedia/streetsmart-api' {
|
|
|
116
116
|
*/
|
|
117
117
|
toggleCompass(visible?: boolean): void;
|
|
118
118
|
|
|
119
|
+
/**
|
|
120
|
+
* Toggles the visibility of the image information in the ObliqueViewer.
|
|
121
|
+
*/
|
|
122
|
+
toggleImageInformation(): void;
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Toggles the visibility of the center map button in the ObliqueViewer.
|
|
126
|
+
*/
|
|
127
|
+
toggleCenterMapVisibility(): void;
|
|
128
|
+
|
|
119
129
|
/**
|
|
120
130
|
* Set the brightness of the oblique viewer.
|
|
121
131
|
* @param {Number} [value] - Set brightness to a positive number, normally use a value between 50 and 150.
|
|
@@ -242,9 +242,33 @@ declare module '@cyclomedia/streetsmart-api' {
|
|
|
242
242
|
|
|
243
243
|
/**
|
|
244
244
|
* Toggles the visibility of the compass in the PanoramaViewer.
|
|
245
|
-
* @param {boolean} [visible]
|
|
246
245
|
*/
|
|
247
|
-
toggleCompass(
|
|
246
|
+
toggleCompass(): void;
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Toggles the visibility of the report blurring in the PanoramaViewer.
|
|
250
|
+
*/
|
|
251
|
+
toggleReportBlurring(): void;
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Toggles the visibility of the mouse position in the PanoramaViewer.
|
|
255
|
+
*/
|
|
256
|
+
toggleMousePosition(): void;
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Toggles the visibility of the image information in the PanoramaViewer.
|
|
260
|
+
*/
|
|
261
|
+
toggleImageInformation(): void;
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Toggles the visibility of the link button in the PanoramaViewer.
|
|
265
|
+
*/
|
|
266
|
+
toggleLinkVisibility(): void;
|
|
267
|
+
|
|
268
|
+
/**
|
|
269
|
+
* Toggles the visibility of the center map button in the PanoramaViewer.
|
|
270
|
+
*/
|
|
271
|
+
toggleCenterMapVisibility(): void;
|
|
248
272
|
|
|
249
273
|
/**
|
|
250
274
|
* Toggles the visibility of the Attribute information panel, deciding if it should be shown on clicking on a feature.
|
|
@@ -310,11 +334,6 @@ declare module '@cyclomedia/streetsmart-api' {
|
|
|
310
334
|
*/
|
|
311
335
|
setElevationSliderLevel(elevationLevel: number): void;
|
|
312
336
|
|
|
313
|
-
/**
|
|
314
|
-
* Toggle viewers from linked to unlinked and vice versa.
|
|
315
|
-
*/
|
|
316
|
-
toggleLinkedViewers: () => void;
|
|
317
|
-
|
|
318
337
|
on<T extends PanoramaViewerEvents | SharedViewerEvents>(
|
|
319
338
|
type: T,
|
|
320
339
|
callback: PanoramaViewerEventCallback<T>,
|