update sampleLegend.show documentation

pearcetm · Jun 29, 2024 · 0af283d · 0af283d
1 parent 14a7aea
commit 0af283d
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ default_options = {
         sampleLegend:{
 
             height: 100,
-            show:'yes',//if not 'yes' a scale of zero will hide the labels
+            show: true, //if false (or falsey) a scale of zero will hide the labels
         },
 
         //colorLegend: defines the width of the legend of cell colors to the right of the grid.

diff --git a/jscomut.js b/jscomut.js
@@ -177,7 +177,7 @@ function Comut() {
             .append('g')
             .attr('class', 'sample-legend')
             .attr('transform', 'translate(0,' + (o-options.innerLayout.margins) + ')' +
-            ' scale(1,' + (options.sampleLegend.show=='yes'?1:0) + ')');
+            ' scale(1,' + (options.sampleLegend.show ? 1 : 0) + ')');
 
         _this.colorLegend = _this.svg
             .append('g')

diff --git a/jscomutdemo.js b/jscomutdemo.js
@@ -2,6 +2,10 @@ $(document).ready(function(){
     var comut = new Comut();
     comut.init({
         target: '#widget',
+		sampleLegend:{
+            height: 200,
+            show: false, //if falsey a scale of zero will hide the labels
+        },
     });
     $('<button>', { class: 'btn btn-default' }).text('Randomize').on('click', function () { comut.randomize(); }).appendTo('#test-buttons');
     $('<button>', { class: 'btn btn-default' }).text('Sort Samples').on('click', function () { comut.sort({ x: true }); }).appendTo('#test-buttons');