simplify handling of equivalent constraint operations

Author: alexcjohnson

src/components/legend/style.js

@@ -67,7 +67,7 @@ module.exports = function style(s, gd) {
 
         if(contours && contours.type === 'constraint') {
             showLine = contours.showlines;
-            showFill = contours.operation !== '=';
+            showFill = contours._operation !== '=';
         }
 
         var fill = d3.select(this).select('.legendfill').selectAll('path')

src/constants/filter_ops.js

@@ -12,5 +12,25 @@ module.exports = {
     COMPARISON_OPS: ['=', '!=', '<', '>=', '>', '<='],
     COMPARISON_OPS2: ['=', '<', '>=', '>', '<='],
     INTERVAL_OPS: ['[]', '()', '[)', '(]', '][', ')(', '](', ')['],
-    SET_OPS: ['{}', '}{']
+    SET_OPS: ['{}', '}{'],
+    CONSTRAINT_REDUCTION: {
+        // for contour constraints, open/closed endpoints are equivalent
+        '=': '=',
+
+        '<': '<',
+        '<=': '<',
+
+        '>': '>',
+        '>=': '>',
+
+        '[]': '[]',
+        '()': '[]',
+        '[)': '[]',
+        '(]': '[]',
+
+        '][': '][',
+        ')(': '][',
+        '](': '][',
+        ')[': ']['
+    }
 };

src/traces/contour/attributes.js

@@ -230,6 +230,8 @@ module.exports = extendFlat({
                 '(' + INTERVAL_OPS + ')',
                 '*value* is expected to be 2-item array where the first item',
                 'is the lower bound and the second item is the upper bound.',
+
+                'Open vs. closed intervals make no difference to constraint display.'
             ].join(' ')
         },
         editType: 'calc',

src/traces/contour/close_boundaries.js

@@ -38,27 +38,23 @@ module.exports = function(pathinfo, operation, perimeter, trace) {
 
     switch(operation) {
         case '>':
-        case '>=':
             if(contours.value > boundaryMax) {
                 pi0.prefixBoundary = true;
             }
             break;
         case '<':
-        case '<=':
             if(contours.value < boundaryMin) {
                 pi0.prefixBoundary = true;
             }
             break;
         case '[]':
-        case '()':
             v1 = Math.min.apply(null, contours.value);
             v2 = Math.max.apply(null, contours.value);
             if(v2 < boundaryMin || v1 > boundaryMax) {
                 pi0.prefixBoundary = true;
             }
             break;
         case '][':
-        case ')(':
             v1 = Math.min.apply(null, contours.value);
             v2 = Math.max.apply(null, contours.value);
             if(v1 < boundaryMin && v2 > boundaryMax) {

src/traces/contour/constraint_defaults.js

@@ -14,12 +14,14 @@ var handleLabelDefaults = require('./label_defaults');
 var Color = require('../../components/color');
 var addOpacity = Color.addOpacity;
 var opacity = Color.opacity;
+var CONSTRAINT_REDUCTION = require('../../constants/filter_ops').CONSTRAINT_REDUCTION;
 
 module.exports = function handleConstraintDefaults(traceIn, traceOut, coerce, layout, defaultColor, opts) {
     var contours = traceOut.contours;
     var showLines, lineColor, fillColor;
 
     var operation = coerce('contours.operation');
+    contours._operation = CONSTRAINT_REDUCTION[operation];
 
     handleConstraintValueDefaults(coerce, contours);
 

src/traces/contour/constraint_mapping.js

@@ -13,22 +13,13 @@ var isNumeric = require('fast-isnumeric');
 
 // This syntax conforms to the existing filter transform syntax, but we don't care
 // about open vs. closed intervals for simply drawing contours constraints:
-module.exports['[]'] = makeRangeSettings('[]');
-module.exports['()'] = makeRangeSettings('()');
-module.exports['[)'] = makeRangeSettings('[)');
-module.exports['(]'] = makeRangeSettings('(]');
-
-// Inverted intervals simply flip the sign:
-module.exports[']['] = makeRangeSettings('][');
-module.exports[')('] = makeRangeSettings(')(');
-module.exports[')['] = makeRangeSettings(')[');
-module.exports[']('] = makeRangeSettings('](');
-
-module.exports['>'] = makeInequalitySettings('>');
-module.exports['>='] = makeInequalitySettings('>=');
-module.exports['<'] = makeInequalitySettings('<');
-module.exports['<='] = makeInequalitySettings('<=');
-module.exports['='] = makeInequalitySettings('=');
+module.exports = {
+    '[]': makeRangeSettings('[]'),
+    '][': makeRangeSettings(']['),
+    '>': makeInequalitySettings('>'),
+    '<': makeInequalitySettings('<'),
+    '=': makeInequalitySettings('=')
+};
 
 // This does not in any way shape or form support calendars. It's adapted from
 // transforms/filter.js.

src/traces/contour/constraint_value_defaults.js

@@ -11,12 +11,12 @@
 
 // var constraintMapping = require('./constraint_mapping');
 var isNumeric = require('fast-isnumeric');
+var COMPARISON_OPS2 = require('../../constants/filter_ops').COMPARISON_OPS2;
 
 module.exports = function(coerce, contours) {
     var zvalue;
-    var scalarValuedOps = ['=', '<', '<=', '>', '>='];
 
-    if(scalarValuedOps.indexOf(contours.operation) === -1) {
+    if(COMPARISON_OPS2.indexOf(contours.operation) === -1) {
         // Requires an array of two numbers:
         coerce('contours.value', [0, 1]);
 

src/traces/contour/convert_to_constraints.js

@@ -23,9 +23,7 @@ module.exports = function(pathinfo, operation) {
     switch(operation) {
         case '=':
         case '<':
-        case '<=':
             return pathinfo;
-        case '>=':
         case '>':
             if(pathinfo.length !== 1) {
                 Lib.warn('Contour data invalid for the specified inequality operation.');
@@ -45,18 +43,12 @@ module.exports = function(pathinfo, operation) {
             }
             return pathinfo;
         case '][':
-        case ')[':
-        case '](':
-        case ')(':
             var tmp = op0;
             op0 = op1;
             op1 = tmp;
             // It's a nice rule, except this definitely *is* what's intended here.
             /* eslint-disable: no-fallthrough */
         case '[]':
-        case '[)':
-        case '(]':
-        case '()':
             /* eslint-enable: no-fallthrough */
             if(pathinfo.length !== 2) {
                 Lib.warn('Contour data invalid for the specified inequality range operation.');

src/traces/contour/empty_pathinfo.js

@@ -14,7 +14,7 @@ var endPlus = require('./end_plus');
 
 module.exports = function emptyPathinfo(contours, plotinfo, cd0) {
     var contoursFinal = (contours.type === 'constraint') ?
-        constraintMapping[contours.operation](contours.value) :
+        constraintMapping[contours._operation](contours.value) :
         contours;
 
     var cs = contoursFinal.size;

src/traces/contour/plot.js

@@ -85,8 +85,8 @@ function plotOne(gd, plotinfo, cd) {
 
     var fillPathinfo = pathinfo;
     if(contours.type === 'constraint') {
-        fillPathinfo = convertToConstraints(pathinfo, contours.operation);
-        closeBoundaries(fillPathinfo, contours.operation, perimeter, trace);
+        fillPathinfo = convertToConstraints(pathinfo, contours._operation);
+        closeBoundaries(fillPathinfo, contours._operation, perimeter, trace);
     }
 
     // draw everything
@@ -131,7 +131,7 @@ function makeFills(plotgroup, pathinfo, perimeter, contours) {
         .classed('contourfill', true);
 
     var fillitems = fillgroup.selectAll('path')
-        .data(contours.coloring === 'fill' || (contours.type === 'constraint' && contours.operation !== '=') ? pathinfo : []);
+        .data(contours.coloring === 'fill' || (contours.type === 'constraint' && contours._operation !== '=') ? pathinfo : []);
     fillitems.enter().append('path');
     fillitems.exit().remove();
     fillitems.each(function(pi) {

src/traces/contourcarpet/plot.js

@@ -50,8 +50,8 @@ function plotOne(gd, plotinfo, cd) {
     var id = 'contour' + uid;
     var pathinfo = emptyPathinfo(contours, plotinfo, cd[0]);
     var isConstraint = contours.type === 'constraint';
-    var isEquality = contours.operation === '=';
-    var coloring = isConstraint ? (isEquality ? 'lines' : 'fill') : contours.coloring;
+    var operation = contours._operation;
+    var coloring = isConstraint ? (operation === '=' ? 'lines' : 'fill') : contours.coloring;
 
     // Map [a, b] (data) --> [i, j] (pixels)
     function ab2p(ab) {
@@ -88,8 +88,8 @@ function plotOne(gd, plotinfo, cd) {
     // See: https://github.com/plotly/plotly.js/issues/1356
     var fillPathinfo = pathinfo;
     if(contours.type === 'constraint') {
-        fillPathinfo = convertToConstraints(pathinfo, contours.operation);
-        closeBoundaries(fillPathinfo, contours.operation, perimeter, trace);
+        fillPathinfo = convertToConstraints(pathinfo, operation);
+        closeBoundaries(fillPathinfo, operation, perimeter, trace);
     }
 
     // Map the paths in a/b coordinates to pixel coordinates: