onViewerImageUpdate (#87)

* onViewerImageUpdate
lwojcik · May 20, 2019 · 2dbabac · 2dbabac
1 parent d52ca96
commit 2dbabac
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 4 deletions.
diff --git a/dist/examples/events.html b/dist/examples/events.html
@@ -42,6 +42,9 @@ <h3>JavaScript</h3>
   onViewerImageGenerate: function() {
     console.log('Viewer image generated');
   },
+  onViewerImageUpdate: function() {
+    console.log('Viewer image updated');
+  },
   onImagesPreload: function() {
     console.log('Images preloaded');
   },
@@ -103,6 +106,9 @@ <h3>JavaScript</h3>
         onViewerImageGenerate: function() {
           console.log('Viewer image generated');
         },
+        onViewerImageUpdate: function() {
+          console.log('Viewer image updated');
+        },
         onImagesPreload: function() {
           console.log('Images preloaded');
         },

diff --git a/dist/js/tridi.d.ts b/dist/js/tridi.d.ts
@@ -30,6 +30,7 @@ interface TridiOptions {
     playable?: boolean;
     onViewerGenerate?: Function | undefined;
     onViewerImageGenerate?: Function | undefined;
+    onViewerImageUpdate?: Function | undefined;
     onHintShow?: Function | undefined;
     onHintHide?: Function | undefined;
     onLoadingScreenShow: Function | undefined;
@@ -81,6 +82,7 @@ declare class Tridi {
     inverse?: boolean;
     onViewerGenerate?: Function | undefined;
     onViewerImageGenerate?: Function | undefined;
+    onViewerImageUpdate?: Function | undefined;
     onHintShow?: Function | undefined;
     onHintHide?: Function | undefined;
     onLoadingScreenShow: Function | undefined;

diff --git a/dist/js/tridi.js b/dist/js/tridi.js
diff --git a/dist/js/tridi.js.map b/dist/js/tridi.js.map
diff --git a/dist/js/tridi.min.d.ts b/dist/js/tridi.min.d.ts
@@ -30,6 +30,7 @@ interface TridiOptions {
     playable?: boolean;
     onViewerGenerate?: Function | undefined;
     onViewerImageGenerate?: Function | undefined;
+    onViewerImageUpdate?: Function | undefined;
     onHintShow?: Function | undefined;
     onHintHide?: Function | undefined;
     onLoadingScreenShow: Function | undefined;
@@ -81,6 +82,7 @@ declare class Tridi {
     inverse?: boolean;
     onViewerGenerate?: Function | undefined;
     onViewerImageGenerate?: Function | undefined;
+    onViewerImageUpdate?: Function | undefined;
     onHintShow?: Function | undefined;
     onHintHide?: Function | undefined;
     onLoadingScreenShow: Function | undefined;

diff --git a/dist/js/tridi.min.js b/dist/js/tridi.min.js
diff --git a/dist/js/tridi.min.js.map b/dist/js/tridi.min.js.map
diff --git a/dist/notes/api.html b/dist/notes/api.html
@@ -305,7 +305,11 @@ <h2 id="events"><a href="#events">Events</a></h2>
                 </tr>
                 <tr id="onViewerImageGenerate">
                   <td><code>onViewerImageGenerate</code></td>
-                  <td>First viewer image is loaded</td>
+                  <td>First viewer image is initially loaded</td>
+                </tr>
+                <tr id="onViewerImageUpdate">
+                  <td><code>onViewerImageUpdate</code></td>
+                  <td>Viewer image is updated</td>
                 </tr>
                 <tr id="onHintShow">
                   <td><code>onHintShow</code></td>

diff --git a/src/tridi.ts b/src/tridi.ts
@@ -38,6 +38,7 @@ interface TridiOptions {
   playable?: boolean;
   onViewerGenerate?: Function | undefined;
   onViewerImageGenerate?: Function | undefined;
+  onViewerImageUpdate?: Function | undefined;
   onHintShow?: Function | undefined;
   onHintHide?: Function | undefined; 
   onLoadingScreenShow: Function | undefined;
@@ -91,6 +92,7 @@ class Tridi {
   inverse?: boolean;
   onViewerGenerate?: Function | undefined;
   onViewerImageGenerate?: Function | undefined;
+  onViewerImageUpdate?: Function | undefined;
   onHintShow?: Function | undefined;
   onHintHide?: Function | undefined;
   onLoadingScreenShow: Function | undefined;
@@ -151,6 +153,7 @@ class Tridi {
     this.mouseleaveDetect = options.mouseleaveDetect || false;
     this.onViewerGenerate = options.onViewerGenerate || undefined;
     this.onViewerImageGenerate = options.onViewerImageGenerate || undefined;
+    this.onViewerImageUpdate = options.onViewerImageUpdate || undefined;
     this.onHintShow = options.onHintShow || undefined;
     this.onHintHide = options.onHintHide || undefined;
     this.onLoadingScreenShow = options.onLoadingScreenShow || undefined;
@@ -444,6 +447,8 @@ class Tridi {
   }
 
   private updateViewerImage(whichImage: number) {
+    /* istanbul ignore next */
+    this.viewerImage().onload = () => this.trigger('onViewerImageUpdate');
     this.viewerImage().src = this.image(whichImage);
   }
 

diff --git a/tests/tridi.test.ts b/tests/tridi.test.ts
@@ -735,6 +735,19 @@ describe('Custom events', () => {
     expect(() => tridi.load()).not.toThrow();
   });
 
+  test(`should accept 'onViewerImageGenerate' event callback`, () => {
+    const tridi = setupTridi(containerId, {
+      ...options,
+      onViewerImageUpdate: () => {
+        return 0;
+      },
+    });
+
+    tridi.load();
+
+    expect(() => tridi.update(options)).not.toThrow();
+  });
+
   test(`should accept 'onImagesPreload' event callback`, () => {
     const tridi = setupTridi(containerId, {
       ...options,