@micrio/client 6.1.0 → 6.1.2
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/micrio.min.d.ts +2 -68
- package/micrio.min.js +2 -2
- package/package.json +1 -1
package/micrio.min.d.ts
CHANGED
|
@@ -466,7 +466,7 @@ declare module '@micrio/client' {
|
|
|
466
466
|
* # Micrio State management
|
|
467
467
|
*
|
|
468
468
|
* Manages the application state using Svelte stores, allowing reactive updates
|
|
469
|
-
* throughout the UI
|
|
469
|
+
* throughout the UI.
|
|
470
470
|
* Replaces the imperative API of Micrio 3.x.
|
|
471
471
|
*
|
|
472
472
|
* Consists of two main state controllers:
|
|
@@ -477,46 +477,13 @@ declare module '@micrio/client' {
|
|
|
477
477
|
* @author Marcel Duin <marcel@micr.io>
|
|
478
478
|
*/
|
|
479
479
|
export namespace State {
|
|
480
|
-
/** Represents the entire serializable state of a Micrio instance. */
|
|
481
|
-
type MicrioStateJSON = {
|
|
482
|
-
/** The ID of the currently active main image. */
|
|
483
|
-
id: string;
|
|
484
|
-
/** Array containing the state of each individual image canvas. */
|
|
485
|
-
c: ImageState[];
|
|
486
|
-
/** Optional information about the currently active tour [tourId, currentTime?, pausedState?]. */
|
|
487
|
-
t?: [string, number?, string?];
|
|
488
|
-
/** Reference to the currently active HTMLMediaElement (unused?). */
|
|
489
|
-
m?: HTMLMediaElement;
|
|
490
|
-
};
|
|
491
|
-
/** Represents the serializable state of a single MicrioImage instance. */
|
|
492
|
-
type ImageState = [
|
|
493
|
-
/** The image ID. */
|
|
494
|
-
string,
|
|
495
|
-
/** The current viewport x0. */
|
|
496
|
-
number,
|
|
497
|
-
/** The current viewport y0. */
|
|
498
|
-
number,
|
|
499
|
-
/** The current viewport x1. */
|
|
500
|
-
number,
|
|
501
|
-
/** The current viewport y1. */
|
|
502
|
-
number,
|
|
503
|
-
/** The ID of the currently opened marker within this image (optional). */
|
|
504
|
-
string?,
|
|
505
|
-
/** The UUID of the media element associated with the opened marker (optional). */
|
|
506
|
-
string?,
|
|
507
|
-
/** The currentTime of the marker's media element (optional). */
|
|
508
|
-
number?,
|
|
509
|
-
/** The paused state ('p') of the marker's media element (optional). */
|
|
510
|
-
string?
|
|
511
|
-
];
|
|
512
480
|
/**
|
|
513
481
|
* # HTMLMicrioElement state controller (`micrio.state`)
|
|
514
482
|
*
|
|
515
483
|
* Manages the global application state associated with the main `<micr-io>` element.
|
|
516
|
-
* Provides Svelte stores for reactive UI updates
|
|
484
|
+
* Provides Svelte stores for reactive UI updates.
|
|
517
485
|
*/
|
|
518
486
|
class Main {
|
|
519
|
-
private micrio;
|
|
520
487
|
/** Writable Svelte store holding the currently active tour object (VideoTour or MarkerTour), or undefined if no tour is active. */
|
|
521
488
|
readonly tour: Writable<Models.ImageData.VideoTour | Models.ImageData.MarkerTour | undefined>;
|
|
522
489
|
/** Getter for the current value of the {@link tour} store. */
|
|
@@ -542,32 +509,6 @@ declare module '@micrio/client' {
|
|
|
542
509
|
/** Writable store: true when gallery controls are hovered or focused, keeping all UI visible. */
|
|
543
510
|
hover: Writable<boolean>;
|
|
544
511
|
};
|
|
545
|
-
/**
|
|
546
|
-
* Gets the current state of the Micrio viewer as a serializable JSON object.
|
|
547
|
-
* This object captures the active image(s), viewports, open markers, active tour,
|
|
548
|
-
* and media playback states, allowing the exact state to be restored later or elsewhere.
|
|
549
|
-
*
|
|
550
|
-
* @example
|
|
551
|
-
* ```javascript
|
|
552
|
-
* const currentState = micrio.state.get();
|
|
553
|
-
* // Store or transmit `currentState`
|
|
554
|
-
* ```
|
|
555
|
-
* @returns The current state as a {@link MicrioStateJSON} object, or undefined if no image is loaded.
|
|
556
|
-
*/
|
|
557
|
-
get(): MicrioStateJSON | undefined;
|
|
558
|
-
/**
|
|
559
|
-
* Sets the Micrio viewer state from a previously saved {@link MicrioStateJSON} object.
|
|
560
|
-
* This will attempt to restore the active image, viewports, open markers, active tour,
|
|
561
|
-
* and media playback states.
|
|
562
|
-
*
|
|
563
|
-
* @example
|
|
564
|
-
* ```javascript
|
|
565
|
-
* const savedState = // ... load state object ...
|
|
566
|
-
* micrio.state.set(savedState);
|
|
567
|
-
* ```
|
|
568
|
-
* @param s The state object to load.
|
|
569
|
-
*/
|
|
570
|
-
set(s: MicrioStateJSON): Promise<void>;
|
|
571
512
|
}
|
|
572
513
|
/**
|
|
573
514
|
* # MicrioImage state controller (`micrioImage.state`)
|
|
@@ -1121,8 +1062,6 @@ declare module '@micrio/client' {
|
|
|
1121
1062
|
keepRendering?: boolean;
|
|
1122
1063
|
/** Don't load GTM module */
|
|
1123
1064
|
noGTag?: boolean;
|
|
1124
|
-
/** With routing enabled, enable marker/tour deeplinks */
|
|
1125
|
-
routerMarkerTours?: boolean;
|
|
1126
1065
|
/** Skip the deepest zoom levels */
|
|
1127
1066
|
skipBaseLevels?: number;
|
|
1128
1067
|
/** The camera animation speed (default: 1) */
|
|
@@ -2312,8 +2251,6 @@ declare module '@micrio/client' {
|
|
|
2312
2251
|
'data-skipmeta'?: boolean;
|
|
2313
2252
|
/** Simulate an <img/> element. No logo, loader bar, and no event listeners. Default: false */
|
|
2314
2253
|
'data-static'?: boolean;
|
|
2315
|
-
/** Read and write deeplinks to opened tours and markers. Default: null */
|
|
2316
|
-
'data-router'?: string;
|
|
2317
2254
|
/** Sending user input as GA Events to any available GTag instance (does nothing if none). Default: true */
|
|
2318
2255
|
'data-gtag'?: boolean;
|
|
2319
2256
|
/** Set the speed factor for camera animations. Default: 1 */
|
|
@@ -2967,8 +2904,6 @@ declare module '@micrio/client' {
|
|
|
2967
2904
|
readonly state: State.Main;
|
|
2968
2905
|
/** The Google Analytics integration controller. */
|
|
2969
2906
|
private readonly analytics;
|
|
2970
|
-
/** The URL router, handling deep linking and history management. */
|
|
2971
|
-
private readonly _router;
|
|
2972
2907
|
/** Writable Svelte store indicating if barebone texture downloading is enabled (lower quality, less bandwidth). */
|
|
2973
2908
|
readonly barebone: Writable<boolean>;
|
|
2974
2909
|
/** Custom settings object provided programmatically, overriding server-fetched settings. */
|
|
@@ -3309,7 +3244,6 @@ declare module '@micrio/client' {
|
|
|
3309
3244
|
export { HLSPlayerAdapter } from "ts/media/hls-adapter";
|
|
3310
3245
|
export { GLEmbedVideo } from "ts/media/embedvideo";
|
|
3311
3246
|
export { VideoTourInstance } from "ts/media/videotour";
|
|
3312
|
-
export { Router } from "ts/nav/router";
|
|
3313
3247
|
export { Grid } from "ts/nav/grid";
|
|
3314
3248
|
export { GallerySwiper } from "ts/nav/swiper";
|
|
3315
3249
|
export { Engine } from "ts/render/engine";
|