finalize multiselect functionality

- use new constraintrange info_array 1-2 dimension format - add multiselect attribute - some further cleanup of conversions - image test to cover most of multiselect logic & precision - interaction tests of ordinal and continuous multiselect - put constraint ranges back into existing mocks
plotly · alexcjohnson · Mar 21, 2018 · Feb 5, 2018 · Mar 3, 2018 · Mar 6, 2018
commit a78db76b08bc8a5470ebc63c8e84c17e90221ea3
diff --git a/src/traces/parcoords/attributes.js b/src/traces/parcoords/attributes.js
@@ -81,28 +81,17 @@ module.exports = {
         constraintrange: {
             valType: 'info_array',
             role: 'info',
+            freeLength: true,
+            dimensions: '1-2',
             items: [
-                {
-                    valType: 'info_array',
-                    editType: 'calc',
-                    items: [
-                        {valType: 'number', editType: 'calc'},
-                        {valType: 'number', editType: 'calc'}
-                    ]
-                },
-                {
-                    valType: 'info_array',
-                    editType: 'calc',
-                    items: [
-                        {valType: 'number', editType: 'calc'},
-                        {valType: 'number', editType: 'calc'}
-                    ]
-                }
+                {valType: 'number', editType: 'calc'},
+                {valType: 'number', editType: 'calc'}
             ],
             editType: 'calc',
             description: [
                 'The domain range to which the filter on the dimension is constrained. Must be an array',
-                'of `[fromValue, toValue]` with finite numbers as elements.'
+                'of `[fromValue, toValue]` with `fromValue <= toValue`, or if `multiselect` is not',
+                'disabled, you may give an array of arrays, where each inner array is `[fromValue, toValue]`.'
             ].join(' ')
         },
         multiselect: {

diff --git a/src/traces/parcoords/axisbrush.js b/src/traces/parcoords/axisbrush.js
@@ -12,6 +12,7 @@ var c = require('./constants');
 var d3 = require('d3');
 var keyFun = require('../../lib/gup').keyFun;
 var repeat = require('../../lib/gup').repeat;
+var sortAsc = require('../../lib').sorterAsc;
 
 function addFilterBarDefs(defs) {
     var filterBarPattern = defs.selectAll('#' + c.id.filterBarPattern)
@@ -115,8 +116,7 @@ function setHighlight(d) {
     if(!filterActive(d.brush)) {
         return '0 ' + d.height;
     }
-    var unitRanges = d.brush.filter.getConsolidated();
-    var pixelRanges = unitRanges.map(function(pr) {return pr.map(d.unitScaleInOrder);});
+    var pixelRanges = unitToPx(d.brush.filter.getConsolidated(), d.height);
     var dashArray = [0]; // we start with a 0 length selection as filter ranges are inclusive, not exclusive
     var p, sectionHeight, iNext;
     var currentGap = pixelRanges.length ? pixelRanges[0][0] : null;
@@ -138,6 +138,12 @@ function setHighlight(d) {
     return dashArray;
 }
 
+function unitToPx(unitRanges, height) {
+    return unitRanges.map(function(pr) {
+        return pr.map(function(v) { return v * height; }).sort(sortAsc);
+    });
+}
+
 function differentInterval(int1) {
     // An interval is different if the extents don't match, which is a safe test only because the intervals
     // get consolidated anyway (ie. the identity of overlapping intervals won't be preserved; they get fused)
@@ -187,9 +193,9 @@ function renderHighlight(root, tweenCallback) {
     styleHighlight(barToStyle);
 }
 
-function getInterval(b, unitScaleInOrder, y) {
+function getInterval(b, height, y) {
     var intervals = b.filter.getConsolidated();
-    var pixIntervals = intervals.map(function(interval) {return interval.map(unitScaleInOrder);});
+    var pixIntervals = unitToPx(intervals, height);
     var hoveredInterval = NaN;
     var previousInterval = NaN;
     var nextInterval = NaN;
@@ -243,8 +249,8 @@ function attachDragBehavior(selection) {
             if(d.parent.inBrushDrag) {
                 return;
             }
-            var y = d.unitScaleInOrder(d.unitScale.invert(d3.mouse(this)[1] + c.verticalPadding));
-            var interval = getInterval(b, d.unitScaleInOrder, y);
+            var y = d.height - d3.mouse(this)[1] - 2 * c.verticalPadding;
+            var interval = getInterval(b, d.height, y);
             d3.select(document.body)
                 .style('cursor', interval.n ? 'n-resize' : interval.s ? 's-resize' : !interval.m ? 'crosshair' : filterActive(b) ? 'ns-resize' : 'crosshair');
         })
@@ -258,10 +264,10 @@ function attachDragBehavior(selection) {
             .on('dragstart', function(d) {
                 var e = d3.event;
                 e.sourceEvent.stopPropagation();
-                var y = d.unitScaleInOrder(d.unitScale.invert(d3.mouse(this)[1] + c.verticalPadding));
+                var y = d.height - d3.mouse(this)[1] - 2 * c.verticalPadding;
                 var unitLocation = d.unitScaleInOrder.invert(y);
                 var b = d.brush;
-                var intData = getInterval(b, d.unitScaleInOrder, y);
+                var intData = getInterval(b, d.height, y);
                 var unitRange = intData.interval;
                 var pixelRange = unitRange.map(d.unitScaleInOrder);
                 var s = b.svgBrush;
@@ -346,13 +352,16 @@ function attachDragBehavior(selection) {
                     s.brushEndCallback(filter.get());
                     return; // no need to fuse intervals or snap to ordinals, so we can bail early
                 }
+
                 var mergeIntervals = function() {
                     // Key piece of logic: once the button is released, possibly overlapping intervals will be fused:
                     // Here it's done immediately on click release while on ordinal snap transition it's done at the end
                     filter.set(filter.getConsolidated());
                 };
+
                 if(d.ordinal) {
-                    var a = d.ordinalScale.range();
+                    var a = d.paddedUnitValues;
+                    if(a[a.length - 1] < a[0]) a = a.slice().sort(sortAsc);
                     s.newExtent = [
                         ordinalScaleSnapLo(a, s.newExtent[0], s.stayingIntervals),
                         ordinalScaleSnapHi(a, s.newExtent[1], s.stayingIntervals)
@@ -366,11 +375,13 @@ function attachDragBehavior(selection) {
                 } else {
                     mergeIntervals(); // merging intervals immediately
                 }
-                s.brushEndCallback(filter.get());
+                s.brushEndCallback(filter.getConsolidated());
             })
         );
 }
 
+function startAsc(a, b) { return a[0] - b[0]; }
+
 function renderAxisBrush(axisBrush) {
 
     var background = axisBrush.selectAll('.background').data(repeat);
@@ -458,7 +469,7 @@ function axisBrushMoved(callback) {
 function dedupeRealRanges(intervals) {
     // Fuses elements of intervals if they overlap, yielding discontiguous intervals, results.length <= intervals.length
     // Currently uses closed intervals, ie. dedupeRealRanges([[400, 800], [300, 400]]) -> [300, 800]
-    var queue = intervals.slice().sort(function(a, b) {return a[0] - b[0];}); // ordered by interval start
+    var queue = intervals.slice();
     var result = [];
     var currentInterval;
     var current = queue.shift();
@@ -475,14 +486,20 @@ function dedupeRealRanges(intervals) {
 function makeFilter() {
     var filter = [];
     var consolidated;
+    var bounds;
     return {
         set: function(a) {
-            filter = a.slice().map(function(d) {return d.slice();});
-            consolidated = dedupeRealRanges(a);
+            filter = a
+                .map(function(d) { return d.slice().sort(sortAsc); })
+                .sort(startAsc);
+            consolidated = dedupeRealRanges(filter);
+            bounds = filter.reduce(function(p, n) {
+                return [Math.min(p[0], n[0]), Math.max(p[1], n[1])];
+            }, [Infinity, -Infinity]);
         },
-        get: function() {return filter.slice();},
-        getConsolidated: function() {return consolidated;}, // would be nice if slow to slice in two layers...
-        getBounds: function() {return filter.reduce(function(p, n) {return [Math.min(p[0], n[0]), Math.max(p[1], n[1])];}, [Infinity, -Infinity]);}
+        get: function() { return filter.slice(); },
+        getConsolidated: function() { return consolidated; },
+        getBounds: function() { return bounds; }
     };
 }
 
@@ -501,9 +518,38 @@ function makeBrush(state, rangeSpecified, initialRange, brushStartCallback, brus
     };
 }
 
+// for use by supplyDefaults, but it needed tons of pieces from here so
+// seemed to make more sense just to put the whole routine here
+function cleanRanges(ranges, dimension) {
+    if(Array.isArray(ranges[0])) {
+        ranges = ranges.map(function(ri) { return ri.sort(sortAsc); });
+
+        if(!dimension.multiselect) ranges = [ranges[0]];
+        else ranges = dedupeRealRanges(ranges.sort(startAsc));
+    }
+    else ranges = [ranges.sort(sortAsc)];
+
+    // ordinal snapping
+    if(dimension.tickvals) {
+        var sortedTickVals = dimension.tickvals.slice().sort(sortAsc);
+        ranges = ranges.map(function(ri) {
+            var rSnapped = [
+                ordinalScaleSnapLo(sortedTickVals, ri[0], []),
+                ordinalScaleSnapHi(sortedTickVals, ri[1], [])
+            ];
+            if(rSnapped[1] > rSnapped[0]) return rSnapped;
+        })
+        .filter(function(ri) { return ri; });
+
+        if(!ranges.length) return;
+    }
+    return ranges.length > 1 ? ranges : ranges[0];
+}
+
 module.exports = {
     addFilterBarDefs: addFilterBarDefs,
     makeBrush: makeBrush,
     ensureAxisBrush: ensureAxisBrush,
-    filterActive: filterActive
+    filterActive: filterActive,
+    cleanRanges: cleanRanges
 };
diff --git a/src/traces/parcoords/defaults.js b/src/traces/parcoords/defaults.js
@@ -14,6 +14,7 @@ var hasColorscale = require('../../components/colorscale/has_colorscale');
 var colorscaleDefaults = require('../../components/colorscale/defaults');
 var maxDimensionCount = require('./constants').maxDimensionCount;
 var handleDomainDefaults = require('../../plots/domain').defaults;
+var axisBrush = require('./axisbrush');
 
 function handleLineDefaults(traceIn, traceOut, defaultColor, layout, coerce) {
     var lineColor = coerce('line.color', defaultColor);
@@ -71,7 +72,10 @@ function dimensionsDefaults(traceIn, traceOut) {
             coerce('range');
 
             coerce('multiselect');
-            coerce('constraintrange');
+            var constraintRange = coerce('constraintrange');
+            if(constraintRange) {
+                dimensionOut.constraintrange = axisBrush.cleanRanges(constraintRange, dimensionOut);
+            }
 
             commonLength = Math.min(commonLength, values.length);
         }

diff --git a/src/traces/parcoords/lines.js b/src/traces/parcoords/lines.js
@@ -173,10 +173,6 @@ function makeAttributes(sampleCount, points) {
     return attributes;
 }
 
-function valid(i, offset, panelCount) {
-    return i + offset <= panelCount;
-}
-
 module.exports = function(canvasGL, d) {
     var model = d.model,
         vm = d.viewModel,
@@ -380,23 +376,20 @@ module.exports = function(canvasGL, d) {
                 for(d = 0; d < 16; d++) {
                     var dimP = d + 16 * abcd;
                     var lim;
-                    if(valid(d, 16 * abcd, panelCount)) {
-                        var dimi = initialDims[dimP === 0 ? 0 : 1 + ((dimP - 1) % (initialDims.length - 1))];
-                        lim = dimi.brush.filter.getBounds()[loHi];
+                    if(dimP < initialDims.length) {
+                        lim = initialDims[dimP].brush.filter.getBounds()[loHi];
                     }
                     else lim = loHi;
                     lims[loHi][abcd][d] = lim + (2 * loHi - 1) * filterEpsilon;
                 }
             }
         }
 
-        var maskExpansion = maskHeight / canvasHeight;
-
         function expandedPixelRange(dim, bounds) {
-            var originalPixelRange = bounds.map(dim.unitScaleInOrder);
+            var maskHMinus = maskHeight - 1;
             return [
-                Math.max(0, Math.floor(originalPixelRange[0] * maskExpansion)),
-                Math.min(maskHeight - 1, Math.ceil(originalPixelRange[1] * maskExpansion))
+                Math.max(0, Math.floor(bounds[0] * maskHMinus)),
+                Math.min(maskHMinus, Math.ceil(bounds[1] * maskHMinus))
             ];
         }
 
@@ -408,7 +401,7 @@ module.exports = function(canvasGL, d) {
             var byteIndex = (dimIndex - bitIndex) / bitsPerByte;
             var bitMask = Math.pow(2, bitIndex);
             var dim = initialDims[dimIndex];
-            var ranges = dim.brush.filter.get().sort(function(a, b) {return a[0] - b[0]; });
+            var ranges = dim.brush.filter.get();
             if(ranges.length < 2) continue; // bail if the bounding box based filter is sufficient
 
             var prevEnd = expandedPixelRange(dim, ranges[0])[1];

diff --git a/src/traces/parcoords/parcoords.js b/src/traces/parcoords/parcoords.js
@@ -67,13 +67,12 @@ function toText(formatter, texts) {
     };
 }
 
-function domainScale(height, padding, dimension) {
+function domainScale(height, padding, dimension, tickvals, ticktext) {
     var extent = dimensionExtent(dimension);
-    var texts = dimension.ticktext;
-    return dimension.tickvals ?
+    return tickvals ?
         d3.scale.ordinal()
-            .domain(dimension.tickvals.map(toText(d3.format(dimension.tickformat), texts)))
-            .range(dimension.tickvals
+            .domain(tickvals.map(toText(d3.format(dimension.tickformat), ticktext)))
+            .range(tickvals
                 .map(function(d) {return (d - extent[0]) / (extent[1] - extent[0]);})
                 .map(function(d) {return (height - 
10000
padding + d * (padding - (height - padding)));})) :
         d3.scale.linear()
@@ -207,6 +206,7 @@ function viewModel(state, callbacks, model) {
         var uScale = unitScale(height, c.verticalPadding);
         var specifiedConstraint = dimension.constraintrange;
         var filterRangeSpecified = specifiedConstraint && specifiedConstraint.length > 0;
+        if(filterRangeSpecified && !Array.isArray(specifiedConstraint[0])) specifiedConstraint = [specifiedConstraint];
         var filterRange = filterRangeSpecified ? specifiedConstraint.map(function(d) {return d.map(domainToUnit).map(paddedUnitScale);}) : [[0, 1]];
         var brushMove = function() {
             var p = viewModel;
@@ -226,13 +226,45 @@ function viewModel(state, callbacks, model) {
             truncatedValues = truncatedValues.slice(0, dimension._length);
         }
 
+        var tickvals = dimension.tickvals;
+        var ticktext;
+        function makeTickItem(v, i) { return {val: v, text: ticktext[i]}; }
+        function sortTickItem(a, b) { return a.val - b.val; }
+        if(Array.isArray(tickvals) && tickvals.length) {
+            ticktext = dimension.ticktext;
+
+            // ensure ticktext and tickvals have same length
+            if(!Array.isArray(ticktext) || !ticktext.length) {
+                ticktext = tickvals.map(d3.format(dimension.tickformat));
+            }
+            else if(ticktext.length > tickvals.length) {
+                ticktext = ticktext.slice(0, tickvals.length);
+            }
+            else if(tickvals.length > ticktext.length) {
+                tickvals = tickvals.slice(0, ticktext.length);
+            }
+
+            // check if we need to sort tickvals/ticktext
+            for(var j = 1; j < tickvals.length; j++) {
+                if(tickvals[j] < tickvals[j - 1]) {
+                    var tickItems = tickvals.map(makeTickItem).sort(sortTickItem);
+                    for(var k = 0; k < tickvals.length; k++) {
+                        tickvals[k] = tickItems[k].val;
+                        ticktext[k] = tickItems[k].text;
+                    }
+                    break;
+                }
+            }
+        }
+        else tickvals = undefined;
+
         return {
             key: key,
             label: dimension.label,
             tickFormat: dimension.tickformat,
-            tickvals: dimension.tickvals,
-            ticktext: dimension.ticktext,
-            ordinal: !!dimension.tickvals,
+            tickvals: tickvals,
+            ticktext: ticktext,
+            ordinal: !!tickvals,
             multiselect: dimension.multiselect,
             xIndex: i,
             crossfilterDimensionIndex: i,
@@ -246,7 +278,7 @@ function viewModel(state, callbacks, model) {
             // fixme remove the old unitScale
             unitScale: uScale,
             unitScaleInOrder: uScaleInOrder,
-            domainScale: domainScale(height, c.verticalPadding, dimension),
+            domainScale: domainScale(height, c.verticalPadding, dimension, tickvals, ticktext),
             ordinalScale: ordinalScale(dimension),
             domainToUnitScale: domainToUnit,
             parent: viewModel,
@@ -268,7 +300,9 @@ function viewModel(state, callbacks, model) {
                         var invScale = domainToUnit.invert;
 
                         // update gd.data as if a Plotly.restyle were fired
-                        var newRanges = f.map(function(r) {return r.map(invertPaddedUnitScale).map(invScale);});
+                        var newRanges = f.map(function(r) {
+                            return r.map(invertPaddedUnitScale).map(invScale).sort(Lib.sorterAsc);
+                        }).sort(function(a, b) { return a[0] - b[0]; });
                         callbacks.filterChanged(p.key, dimension._index, newRanges);
                     }
                 }

diff --git a/src/traces/parcoords/plot.js b/src/traces/parcoords/plot.js
@@ -46,9 +46,22 @@ module.exports = function plot(gd, cdparcoords) {
         // without having to incur heavy UI blocking due to an actual `Plotly.restyle` call
 
         var gdDimension = gdDimensionsOriginalOrder[i][originalDimensionIndex];
-        gdDimension.constraintrange = newRanges.map(function(r) {return r.slice();});
+        var newConstraints = newRanges.map(function(r) { return r.slice(); });
+        if(!newConstraints.length) {
+            delete gdDimension.constraintrange;
+            newConstraints = null;
+        }
+        else {
+            if(newConstraints.length === 1) newConstraints = newConstraints[0];
+            gdDimension.constraintrange = newConstraints;
+            // wrap in another array for restyle event data
+            newConstraints = [newConstraints];
+        }
 
-        gd.emit('plotly_restyle');
+        var restyleData = {};
+        var aStr = 'dimensions[' + originalDimensionIndex + '].constraintrange';
+        restyleData[aStr] = newConstraints;
+        gd.emit('plotly_restyle', [restyleData, [i]]);
     };
 
     var hover = function(eventData) {

diff --git a/test/image/baselines/gl2d_parcoords.png b/test/image/baselines/gl2d_parcoords.png
diff --git a/test/image/baselines/gl2d_parcoords_1.png b/test/image/baselines/gl2d_parcoords_1.png
diff --git a/test/image/baselines/gl2d_parcoords_2.png b/test/image/baselines/gl2d_parcoords_2.png
diff --git a/test/image/baselines/gl2d_parcoords_constraints.png b/test/image/baselines/gl2d_parcoords_constraints.png
diff --git a/test/image/baselines/gl2d_parcoords_large.png b/test/image/baselines/gl2d_parcoords_large.png