check if offset>0 during instantiation, add warning, update doc

calipho-sib · May 24, 2016 · 9bdb565 · 9bdb565
1 parent fda2987
commit 9bdb565
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 12 deletions.
diff --git a/dist/feature-viewer.bundle.js b/dist/feature-viewer.bundle.js
diff --git a/dist/feature-viewer.min.js b/dist/feature-viewer.min.js
diff --git a/dist/feature-viewer.nextprot.js b/dist/feature-viewer.nextprot.js
diff --git a/examples/index.html b/examples/index.html
@@ -68,7 +68,7 @@ <h4 class="text-center">Step 1 - Initialize the Feature Viewer</h4>
                             multiple of ten.
                         </li>
                         <li><strong>animation</strong> <em>(boolean)</em> : Animation during transition</li>
-                        <li><strong>offset</strong> <em>(object)</em> : Specify an offset : offset:{start:40,end:100}</li>
+                        <li><strong>offset</strong> <em>(object)</em> : Specify an offset (offset.start should always be > 0). <br>Ex : <span style="font-family:monospace;background-color:#eee;">offset:{start:40,end:100}</span></li>
                     </ul>
                     <p>The brush zoom will allow you to select a part of the sequence to zoom in. <br>
                         It may happen that the div is too small to display the sequence, but a zoom will make it
@@ -234,8 +234,12 @@ <h4 class="text-center">Step 2 - Add some features</h4>
                     <h4 class="text-center">Events</h4>
                 </div>
                 <div class="panel-body">
-                    <p>You can listen for a click on a feature, and get the specific positions of this feature with the listener <strong>onFeatureSelected</strong>. <br>
-                        This method take a custom function in parameter allowing you to link this event with the rest of your application.</p>
+                    <p>You can listen for some events :</p>
+                    <ul>
+                        <li><strong>onFeatureSelected</strong> : A click on a feature, return an object with the specific positions of this feature</li>
+                        <li><strong>onZoom</strong> : When a zoom occurs, return an object with the coordinates and zoom level</li>
+                    </ul>
+                        <p>Those methods take a custom function (callback) in parameter, receiving the event object, allowing you to link the event with the rest of your application.</p>
                 </div>
                 <form>
                 <textarea id="code3" name="code3" style="width:500px;max-height:200px;overflow:auto;font-size:11px;">
@@ -303,7 +307,11 @@ <h4 class="text-center">Events</h4>
 ft3.onFeatureSelected(function (d) {
     console.log(d.detail);
 });
-
+
+//Get and print in the browser console the zoom level and coordinates
+ft3.onZoom(function (d) {
+    console.log(d.detail);
+});
 
                 </textarea>
                 </form>

diff --git a/src/feature-viewer.js b/src/feature-viewer.js
@@ -23,7 +23,13 @@ var FeatureViewer = (function () {
             verticalLine: false
         };
         var offset = {start:1,end:fvLength};
-        if (options && options.offset) offset = options.offset;
+        if (options && options.offset) {
+            offset = options.offset;
+            if (offset.start < 1) {
+                offset.start = 1;
+                console.warn("WARNING ! offset.start should be > 0. Thus, it has been reset to 1.");
+            }
+        }
         var pathLevel = 0;
         var svg;
         var svgContainer;
@@ -1416,7 +1422,7 @@ var FeatureViewer = (function () {
 
             if (!$.fn.popover) {
                 options.bubbleHelp = false;
-                console.warn("The bubble help requires tooltip and popover bootrstrap js libraries. The feature viewer will continue to work, but without the info bubble");
+                console.warn("The bubble help requires tooltip and popover bootstrap js libraries. The feature viewer will continue to work, but without the info bubble");
             }
 
             // Create SVG