reduced opacityscale code - updated baseline - revised jasmine test

Author: archmoj

src/lib/coerce.js

@@ -13,7 +13,6 @@ var tinycolor = require('tinycolor2');
 
 var baseTraceAttrs = require('../plots/attributes');
 var colorscales = require('../components/colorscale/scales');
-var opacityscales = require('../traces/volume/opacityscale');
 var DESELECTDIM = require('../constants/interactions').DESELECTDIM;
 
 var nestedProperty = require('./nested_property');
@@ -177,21 +176,6 @@ exports.valObjectMeta = {
             propOut.set(colorscales.get(v, dflt));
         }
     },
-    opacityscale: {
-        description: [
-            'A Plotly opacityscale either picked by a name:',
-            '(any of', Object.keys(opacityscales.scales).join(', '), ')',
-            'customized as an {array} of 2-element {arrays} where',
-            'the first element is the normalized opacity level value',
-            '(starting at *0* and ending at *1*),',
-            'and the second item is a valid opacity value between 0 and 1.'
-        ].join(' '),
-        requiredOpts: [],
-        otherOpts: ['dflt'],
-        coerceFunction: function(v, propOut, dflt) {
-            propOut.set(opacityscales.get(v, dflt));
-        }
-    },
     angle: {
         description: [
             'A number (in degree) between -180 and 180.'

src/traces/volume/attributes.js

@@ -8,7 +8,6 @@
 
 'use strict';
 
-var opacityscaleAttrs = require('./opacityscale').attributes;
 var colorscaleAttrs = require('../../components/colorscale/attributes');
 var isosurfaceAttrs = require('../isosurface/attributes');
 var baseAttrs = require('../../plots/attributes');
@@ -56,10 +55,6 @@ var attrs = module.exports = overrideAll(extendFlat({
     hovertemplate: isosurfaceAttrs.hovertemplate
 },
 
-opacityscaleAttrs('', {
-    editTypeOverride: 'calc'
-}),
-
 colorscaleAttrs('', {
     colorAttr: '`value`',
     showScaleDflt: true,
@@ -68,6 +63,24 @@ colorscaleAttrs('', {
 
     colorbar: isosurfaceAttrs.colorbar,
     opacity: isosurfaceAttrs.opacity,
+    opacityscale: {
+        valType: 'any',
+        role: 'style',
+        editType: 'calc',
+        description: [
+            'Sets the opacityscale.',
+            ' The opacityscale must be an array containing',
+            ' arrays mapping a normalized value to an opacity value.',
+            ' At minimum, a mapping for the lowest (0) and highest (1)',
+            ' values are required. For example,',
+            ' `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have',
+            ' higher opacity values and those in the middle would be more transparent',
+            ' Alternatively, `opacityscale` may be a palette name string',
+            ' of the following list: \'min\', \'max\', \'extremes\' and \'uniform\'.',
+            ' The default is \'uniform\'.'
+        ].join('')
+    },
+
     lightposition: isosurfaceAttrs.lightposition,
     lighting: isosurfaceAttrs.lighting,
     flatshading: isosurfaceAttrs.flatshading,

src/traces/volume/defaults.js

@@ -9,16 +9,63 @@
 'use strict';
 
 var isosurfaceDefaults = require('../isosurface/defaults');
-var opacityscaleDefaults = require('./opacityscale').defaults;
 var Lib = require('../../lib');
 var attributes = require('./attributes');
 
+var MIN = 0.1; // Note: often we don't want the data cube to be disappeared
+
+function createWave(n, minOpacity) {
+    var arr = [];
+    var steps = 32; // Max: 256
+    for(var i = 0; i < steps; i++) {
+        var u = i / (steps - 1);
+        var v = minOpacity + (1 - minOpacity) * (1 - Math.pow(Math.sin(n * u * Math.PI), 2));
+        arr.push([
+            u,
+            Math.max(1, Math.min(0, v))
+        ]);
+    }
+    return arr;
+}
+
 module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     function coerce(attr, dflt) {
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
     isosurfaceDefaults(traceIn, traceOut, defaultColor, layout);
 
-    opacityscaleDefaults(traceIn, traceOut, layout, coerce, {prefix: ''});
+    var opacityscale = coerce('opacityscale');
+    if(opacityscale === 'max') {
+        traceOut.opacityscale = [[0, MIN], [1, 1]];
+    } else if(opacityscale === 'min') {
+        traceOut.opacityscale = [[0, 1], [1, MIN]];
+    } else if(opacityscale === 'extremes') {
+        traceOut.opacityscale = createWave(1, MIN);
+    } else if(!isValidScaleArray(opacityscale)) {
+        traceOut.opacityscale = undefined;
+    }
+
 };
+
+function isValidScaleArray(scl) {
+    var highestVal = 0;
+
+    if(!Array.isArray(scl) || scl.length < 2) return false;
+
+    if(!scl[0] || !scl[scl.length - 1]) return false;
+
+    if(+scl[0][0] !== 0 || +scl[scl.length - 1][0] !== 1) return false;
+
+    for(var i = 0; i < scl.length; i++) {
+        var si = scl[i];
+
+        if(si.length !== 2 || +si[0] < highestVal) {
+            return false;
+        }
+
+        highestVal = +si[0];
+    }
+
+    return true;
+}

src/traces/volume/opacityscale.js

@@ -314,7 +314,7 @@ describe('Test volume', function() {
         });
     });
 
-    describe('@noCI hover', function() {
+    describe('hover', function() {
 
         var gd;
 
@@ -358,8 +358,8 @@ describe('Test volume', function() {
                     nums: [
                         'x: 0.4',
                         'y: 100μ',
-                        'z: −16',
-                        'value: −1.32'
+                        'z: −8',
+                        'value: −1.31'
                     ].join('\n')
                 });
             })
@@ -368,10 +368,10 @@ describe('Test volume', function() {
             .then(function() {
                 assertHoverLabelContent({
                     nums: [
-                        'x: 0.3',
+                        'x: 0.4',
                         'y: 0.001',
                         'z: −16',
-                        'value: −0.27'
+                        'value: −0.32'
                     ].join('\n')
                 });
             })
@@ -382,8 +382,8 @@ describe('Test volume', function() {
                     nums: [
                         'x: 0.3',
                         'y: 100μ',
-                        'z: −16',
-                        'value: −1.2'
+                        'z: −8',
+                        'value: −1.19'
                     ].join('\n')
                 });
             })
@@ -393,9 +393,9 @@ describe('Test volume', function() {
                 assertHoverLabelContent({
                     nums: [
                         'x: 0.4',
-                        'y: 100μ',
-                        'z: −4',
-                        'value: −1.3'
+                        'y: 0.001',
+                        'z: −2',
+                        'value: −1.26'
                     ].join('\n')
                 });
             })