@micrio/client 5.3.2 → 5.3.3

package/micrio.min.d.ts

@@ -4,7 +4,7 @@ declare module '@micrio/client' {
 	 * Defines the current version of the Micrio library.
 	 * This constant is used internally and exposed statically via `HTMLMicrioElement.VERSION`.
 	 */
-	export const VERSION = "5.3.2";
+	export const VERSION = "5.3.3";
 	/**
 	 * Loads an image texture asynchronously. Adds the request to the queue
 	 * and returns a Promise that resolves with the TextureBitmap or rejects on error.
@@ -753,7 +753,7 @@ declare module '@micrio/client' {
 		/**
 		 * Parses an individual image grid string into a GridImage object.
 		 * @param s The grid string for a single image.
-		 * @returns The parsed {@link Models.Grid.GridImage} object.
+		 * @returns The parsed `Models.Grid.GridImage` object.
 		*/
 		getImage(s: string): Models.Grid.GridImage;
 		/**
@@ -2060,69 +2060,117 @@ declare module '@micrio/client' {
 			detail: T;
 		};
 		interface MicrioEventDetails {
+			/** The main Micrio image is loaded and fully shown */
 			'show': HTMLMicrioElement;
+			/** Before the ImageInfo settings are read, this event allows you to alter them */
 			'pre-info': ImageInfo.ImageInfo;
+			/** Before the ImageData contents are read, this event allows you to alter it */
 			'pre-data': {
 				[micrioId: string]: ImageData.ImageData;
 			};
+			/** The main Micrio element has initialized and is being printed */
 			'print': ImageInfo.ImageInfo;
+			/** Individual image data is loaded and Micrio will start rendering */
 			'load': MicrioImage;
+			/** The user has switched available languages */
 			'lang-switch': string;
+			/** The camera has zoomed */
 			'zoom': {
 				image: MicrioImage;
 				view: Camera.View;
 			};
+			/** The camera has moved */
 			'move': {
 				image: MicrioImage;
 				view: Camera.View;
 			};
+			/** A frame has been drawn */
 			'draw': void;
+			/** The <micr-io> element was resized */
 			'resize': DOMRect;
+			/** The user has started panning */
 			'panstart': void;
+			/** The user has stopped panning */
 			'panend': {
 				duration: number;
 				movedX: number;
 				movedY: number;
 			};
+			/** The user has stopped pinching */
 			'pinchstart': void;
+			/** The user has stopped pinching */
 			'pinchend': {
 				duration: number;
 				movedX: number;
 				movedY: number;
 			};
+			/** A marker has been opened and the camera animation is starting */
 			'marker-open': ImageData.Marker;
+			/** A marker has been fully opened and the camera is done, and popup shown */
 			'marker-opened': ImageData.Marker;
+			/** A marker has been successfully closed */
 			'marker-closed': ImageData.Marker;
+			/** A tour has been successfully started */
 			'tour-start': ImageData.Tour;
+			/** A tour has been successfully stopped */
 			'tour-stop': ImageData.Tour;
+			/** A tour's UI interface has automatically minimized */
 			'tour-minimize': ImageData.Tour;
+			/** Fires for each marker step in a marker tour */
 			'tour-step': ImageData.MarkerTour;
+			/** A multi-image tour is played/resumed */
 			'serialtour-play': ImageData.MarkerTour;
+			/** A multi-image tour is paused */
 			'serialtour-pause': ImageData.MarkerTour;
+			/** A video tour has started from the beginning (can be part of a marker tour) */
 			'videotour-start': ImageData.VideoTour;
+			/** A video tour has ended or is aborted (can be part of a marker tour) */
 			'videotour-stop': ImageData.VideoTour;
+			/** A video tour is played or resumed */
 			'videotour-play': void;
+			/** A video tour is paused */
 			'videotour-pause': void;
+			/** A video tour has ended */
 			'tour-ended': ImageData.VideoTour;
+			/** When a video tour has custom events, they will be fired like this */
 			'tour-event': ImageData.Event;
+			/** The audio controller has been successfully initialized and can play audio */
 			'audio-init': void;
+			/** The audio has been muted */
 			'audio-mute': void;
+			/** The audio has been unmuted */
 			'audio-unmute': void;
+			/** Fires when there is autoplay audio or video which was disallowed by the browser */
 			'autoplay-blocked': void;
+			/** Media has started playing */
 			'media-play': void;
+			/** Media has stopped playing */
 			'media-pause': void;
+			/** Media has ended */
 			'media-ended': void;
+			/** A media timeupdate tick */
 			'timeupdate': number;
+			/** A custom popover page was opened */
 			'page-open': ImageData.Menu;
+			/** A custom popover page was closed */
 			'page-closed': ImageData.Menu;
+			/** Triggers on album image change */
 			'gallery-show': number;
+			/** The grid controller has initialized */
 			'grid-init': Grid;
+			/** All images in the grid have loaded */
 			'grid-load': void;
+			/** The grid layout has changed */
 			'grid-layout-set': Grid;
+			/** The main grid view is activated */
 			'grid-focus': MicrioImage;
+			/** The main grid has lost focus, i.e., navigated away */
 			'grid-blur': void;
+			/** Split screen mode has started */
 			'splitscreen-start': MicrioImage;
+			/** Split screen mode has stopped */
 			'splitscreen-stop': MicrioImage;
+			/** When there is any user action, this event fires. Deferred and fires at a maximum rate of every 500ms */
 			'update': Array<string>;
 		}
 		type MicrioEventMap = {