implement violinmode, violingroup and violingroupgap

etpinard · etpinard · commit 7769f203a5b7 · 2017-10-30T23:31:03.000-04:00
- totally indenpendent from their box* counterpart
diff --git a/src/traces/box/calc.js b/src/traces/box/calc.js
@@ -18,16 +18,16 @@ module.exports = function calc(gd, trace) {
     var fullLayout = gd._fullLayout;
     var xa = Axes.getFromId(gd, trace.xaxis || 'x');
     var ya = Axes.getFromId(gd, trace.yaxis || 'y');
-    var orientation = trace.orientation;
     var cd = [];
 
-    var numKey = '_numBoxes';
+    // N.B. violin reuses same Box.calc
+    var numKey = trace.type === 'violin' ? '_numViolins' : '_numBoxes';
 
     var i;
     var valAxis, valLetter;
     var posAxis, posLetter;
 
-    if(orientation === 'h') {
+    if(trace.orientation === 'h') {
         valAxis = xa;
         valLetter = 'x';
         posAxis = ya;
@@ -119,7 +119,9 @@ module.exports = function calc(gd, trace) {
     if(cd.length > 0) {
         cd[0].t = {
             num: fullLayout[numKey],
-            dPos: dPos
+            dPos: dPos,
+            posLetter: posLetter,
+            valLetter: valLetter
         };
 
         fullLayout[numKey]++;
diff --git a/src/traces/box/index.js b/src/traces/box/index.js
@@ -15,7 +15,7 @@ Box.layoutAttributes = require('./layout_attributes');
 Box.supplyDefaults = require('./defaults').supplyDefaults;
 Box.supplyLayoutDefaults = require('./layout_defaults').supplyLayoutDefaults;
 Box.calc = require('./calc');
-Box.setPositions = require('./set_positions');
+Box.setPositions = require('./set_positions').setPositions;
 Box.plot = require('./plot').plot;
 Box.style = require('./style');
 Box.hoverPoints = require('./hover').hoverPoints;
diff --git a/src/traces/box/layout_defaults.js b/src/traces/box/layout_defaults.js
@@ -8,23 +8,22 @@
 
 'use strict';
 
-var Registry = require('../../registry');
 var Lib = require('../../lib');
 var layoutAttributes = require('./layout_attributes');
 
-function _supply(layoutIn, layoutOut, fullData, coerce, prefix) {
-    var hasBoxes;
+function _supply(layoutIn, layoutOut, fullData, coerce, traceType) {
+    var hasTraceType;
     for(var i = 0; i < fullData.length; i++) {
-        if(Registry.traceIs(fullData[i], 'box')) {
-            hasBoxes = true;
+        if(fullData[i].type === traceType) {
+            hasTraceType = true;
             break;
         }
     }
-    if(!hasBoxes) return;
+    if(!hasTraceType) return;
 
-    coerce(prefix + 'mode');
-    coerce(prefix + 'gap');
-    coerce(prefix + 'groupgap');
+    coerce(traceType + 'mode');
+    coerce(traceType + 'gap');
+    coerce(traceType + 'groupgap');
 }
 
 function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
diff --git a/src/traces/box/set_positions.js b/src/traces/box/set_positions.js
@@ -8,95 +8,102 @@
 
 'use strict';
 
-var Registry = require('../../registry');
 var Axes = require('../../plots/cartesian/axes');
 var Lib = require('../../lib');
 
-module.exports = function setPositions(gd, plotinfo) {
-    var fullLayout = gd._fullLayout;
+var orientations = ['v', 'h'];
+
+function setPositions(gd, plotinfo) {
+    var calcdata = gd.calcdata;
     var xa = plotinfo.xaxis;
     var ya = plotinfo.yaxis;
-    var orientations = ['v', 'h'];
-
-    // TODO figure this out
-    // should violins and boxes share 'num' fields?
-    var numKey = '_numBoxes';
-
-    var posAxis, i, j, k;
 
-    for(i = 0; i < orientations.length; ++i) {
-        var orientation = orientations[i],
-            boxlist = [],
-            boxpointlist = [],
-            minPad = 0,
-            maxPad = 0,
-            cd,
-            t,
-            trace;
-
-        // set axis via orientation
-        if(orientation === 'h') posAxis = ya;
-        else posAxis = xa;
+    for(var i = 0; i < orientations.length; i++) {
+        var orientation = orientations[i];
+        var posAxis = orientation === 'h' ? ya : xa;
+        var boxList = [];
+        var minPad = 0;
+        var maxPad = 0;
 
         // make list of boxes
-        for(j = 0; j < gd.calcdata.length; ++j) {
-            cd = gd.calcdata[j];
-            t = cd[0].t;
-            trace = cd[0].trace;
+        for(var j = 0; j < calcdata.length; j++) {
+            var cd = calcdata[j];
+            var t = cd[0].t;
+            var trace = cd[0].trace;
 
             if(trace.visible === true && trace.type === 'box' &&
                     !t.empty &&
                     trace.orientation === orientation &&
                     trace.xaxis === xa._id &&
-                    trace.yaxis === ya._id) {
-                boxlist.push(j);
+                    trace.yaxis === ya._id
+              ) {
+                boxList.push(j);
+
                 if(trace.boxpoints !== false) {
                     minPad = Math.max(minPad, trace.jitter - trace.pointpos - 1);
                     maxPad = Math.max(maxPad, trace.jitter + trace.pointpos - 1);
                 }
             }
         }
 
-        // make list of box points
-        for(j = 0; j < boxlist.length; j++) {
-            cd = gd.calcdata[boxlist[j]];
-            for(k = 0; k < cd.length; k++) boxpointlist.push(cd[k].pos);
-        }
-        if(!boxpointlist.length) continue;
+        setPositionOffset('box', gd, boxList, posAxis, [minPad, maxPad]);
+    }
+}
 
-        // box plots - update dPos based on multiple traces
-        // and then use for posAxis autorange
+function setPositionOffset(traceType, gd, boxList, posAxis, pad) {
+    var calcdata = gd.calcdata;
+    var fullLayout = gd._fullLayout;
+    var pointList = [];
+
+    // N.B. reused in violin
+    var numKey = traceType === 'violin' ? '_numViolins' : '_numBoxes';
 
-        var boxdv = Lib.distinctVals(boxpointlist);
-        var dPos = boxdv.minDiff / 2;
+    var i, j, calcTrace;
 
-        // if there's no duplication of x points,
-        // disable 'group' mode by setting counter to 1
-        if(boxpointlist.length === boxdv.vals.length) {
-            fullLayout[numKey] = 1;
+    // make list of box points
+    for(i = 0; i < boxList.length; i++) {
+        calcTrace = calcdata[boxList[i]];
+        for(j = 0; j < calcTrace.length; j++) {
+            pointList.push(calcTrace[j].pos);
         }
+    }
 
-        // check for forced minimum dtick
-        Axes.minDtick(posAxis, boxdv.minDiff, boxdv.vals[0], true);
+    if(!pointList.length) return;
 
-        // set the width of all boxes
-        for(i = 0; i < boxlist.length; i++) {
-            var boxListIndex = boxlist[i];
-            gd.calcdata[boxListIndex][0].t.dPos = dPos;
-        }
+    // box plots - update dPos based on multiple traces
+    // and then use for posAxis autorange
+    var boxdv = Lib.distinctVals(pointList);
+    var dPos = boxdv.minDiff / 2;
 
-        // TODO this won't work when both boxes and violins are present
-        // on same graph
-        var gap = fullLayout.boxgap || fullLayout.violingap;
-        var groupgap = fullLayout.boxgroupgap || fullLayout.violingroupgap;
-
-        // autoscale the x axis - including space for points if they're off the side
-        // TODO: this will overdo it if the outermost boxes don't have
-        // their points as far out as the other boxes
-        var padfactor = (1 - gap) * (1 - groupgap) * dPos / fullLayout[numKey];
-        Axes.expand(posAxis, boxdv.vals, {
-            vpadminus: dPos + minPad * padfactor,
-            vpadplus: dPos + maxPad * padfactor
-        });
+    // if there's no duplication of x points,
+    // disable 'group' mode by setting counter to 1
+    if(pointList.length === boxdv.vals.length) {
+        fullLayout[numKey] = 1;
     }
+
+    // check for forced minimum dtick
+    Axes.minDtick(posAxis, boxdv.minDiff, boxdv.vals[0], true);
+
+    // set the width of all boxes
+    for(i = 0; i < boxList.length; i++) {
+        calcTrace = calcdata[boxList[i]];
+        calcTrace[0].t.dPos = dPos;
+    }
+
+    var gap = fullLayout[traceType + 'gap'];
+    var groupgap = fullLayout[traceType + 'groupgap'];
+    var padfactor = (1 - gap) * (1 - groupgap) * dPos / fullLayout[numKey];
+
+    // autoscale the x axis - including space for points if they're off the side
+    // TODO: this will overdo it if the outermost boxes don't have
+    // their points as far out as the other boxes
+    Axes.expand(posAxis, boxdv.vals, {
+        vpadminus: dPos + pad[0] * padfactor,
+        vpadplus: dPos + pad[1] * padfactor
+    });
+}
+
+module.exports = {
+    setPositions: setPositions,
+    setPositionOffset: setPositionOffset
 };
diff --git a/src/traces/violin/index.js b/src/traces/violin/index.js
@@ -14,7 +14,7 @@ module.exports = {
     supplyDefaults: require('./defaults'),
     supplyLayoutDefaults: require('./layout_defaults'),
     calc: require('./calc'),
-    setPositions: require('../box/set_positions'),
+    setPositions: require('./set_positions'),
     plot: require('./plot'),
     style: require('./style'),
     hoverPoints: require('../box/hover'),
diff --git a/src/traces/violin/layout_attributes.js b/src/traces/violin/layout_attributes.js
@@ -11,7 +11,6 @@
 var boxLayoutAttrs = require('../box/layout_attributes');
 
 // TODO update descriptions
-// ... or maybe just reuse box* attributes?
 module.exports = {
     violinmode: boxLayoutAttrs.boxmode,
     violingap: boxLayoutAttrs.boxgap,
diff --git a/src/traces/violin/plot.js b/src/traces/violin/plot.js
@@ -30,7 +30,7 @@ module.exports = function plot(gd, plotinfo, cd) {
         var t = cd0.t;
         var trace = cd0.trace;
         var sel = cd0.node3 = d3.select(this);
-        var numViolins = fullLayout._numBoxes;
+        var numViolins = fullLayout._numViolins;
         var group = (fullLayout.violinmode === 'group' && numViolins > 1);
         // violin max half width
         var bdPos = t.bdPos = t.dPos * (1 - fullLayout.violingap) * (1 - fullLayout.violingroupgap) / (group ? numViolins : 1);
diff --git a/src/traces/violin/set_positions.js b/src/traces/violin/set_positions.js
@@ -0,0 +1,48 @@
+/**
+* Copyright 2012-2017, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var setPositionOffset = require('../box/set_positions').setPositionOffset;
+var orientations = ['v', 'h'];
+
+module.exports = function setPositions(gd, plotinfo) {
+    var calcdata = gd.calcdata;
+    var xa = plotinfo.xaxis;
+    var ya = plotinfo.yaxis;
+
+    for(var i = 0; i < orientations.length; i++) {
+        var orientation = orientations[i];
+        var posAxis = orientation === 'h' ? ya : xa;
+        var violinList = [];
+        var minPad = 0;
+        var maxPad = 0;
+
+        for(var j = 0; j < calcdata.length; j++) {
+            var cd = calcdata[j];
+            var t = cd[0].t;
+            var trace = cd[0].trace;
+
+            if(trace.visible === true && trace.type === 'violin' &&
+                    !t.empty &&
+                    trace.orientation === orientation &&
+                    trace.xaxis === xa._id &&
+                    trace.yaxis === ya._id
+              ) {
+                violinList.push(j);
+
+                if(trace.points !== false) {
+                    minPad = Math.max(minPad, trace.jitter - trace.pointpos - 1);
+                    maxPad = Math.max(maxPad, trace.jitter + trace.pointpos - 1);
+                }
+            }
+        }
+
+        setPositionOffset('violin', gd, violinList, posAxis, [minPad, maxPad]);
+    }
+};
