Volume traces

lib/index-gl3d.js

@@ -15,7 +15,8 @@ Plotly.register([
     require('./surface'),
     require('./mesh3d'),
     require('./cone'),
-    require('./streamtube')
+    require('./streamtube'),
+    require('./volume')
 ]);
 
 module.exports = Plotly;

lib/index.js

@@ -28,6 +28,7 @@ Plotly.register([
     require('./mesh3d'),
     require('./cone'),
     require('./streamtube'),
+    require('./volume'),
 
     require('./scattergeo'),
     require('./choropleth'),

lib/volume.js

@@ -0,0 +1,11 @@
+/**
+* Copyright 2012-2018, 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';
+
+module.exports = require('../src/traces/volume');

package.json

@@ -84,6 +84,7 @@
     "gl-select-box": "^1.0.2",
     "gl-spikes2d": "^1.0.1",
     "gl-streamtube3d": "^1.0.0",
+    "gl-volume3d": "^0.5.0",
     "gl-surface3d": "^1.3.5",
     "glslify": "^6.2.1",
     "has-hover": "^1.0.1",

src/traces/volume/attributes.js

@@ -0,0 +1,111 @@
+/**
+* Copyright 2012-2018, 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 colorscaleAttrs = require('../../components/colorscale/attributes');
+var colorbarAttrs = require('../../components/colorbar/attributes');
+var mesh3dAttrs = require('../mesh3d/attributes');
+var baseAttrs = require('../../plots/attributes');
+
+var extendFlat = require('../../lib/extend').extendFlat;
+
+var attrs = {
+    x: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: [
+            'Sets the x coordinates of the volume'
+        ].join(' ')
+    },
+    y: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: [
+            'Sets the y coordinates of the volume'
+        ].join(' ')
+    },
+    z: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: [
+            'Sets the z coordinates of the volume'
+        ].join(' ')
+    },
+
+    value: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc',
+        description: 'Sets the intensity values of the volume.'
+    },
+
+    opacityscale: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc',
+        description: [
+            'Sets the opacity scale of the volume.',
+            'Defines which opacity to use for which intensity.',
+            'Multiplied with trace.opacity to obtain the final opacity.',
+            'Colorscale-like array of [[0, opacity0], [v1, opacity1], ..., [1, opacityN]].'
+        ].join(' ')
+    },
+
+    imin: {
+        valType: 'number',
+        role: 'info',
+        editType: 'calc',
+        description: 'Sets the minimum intensity bound of the volume.'
+    },
+
+    imax: {
+        valType: 'number',
+        role: 'info',
+        editType: 'calc',
+        description: 'Sets the maximum intensity bound of the volume.'
+    },
+
+    text: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        arrayOk: true,
+        editType: 'calc',
+        description: [
+            'Sets the text elements associated with the volume points.',
+            'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
+            'these elements will be seen in the hover labels.'
+        ].join(' ')
+    }
+};
+
+extendFlat(attrs, colorscaleAttrs('', {
+    colorAttr: 'value',
+    showScaleDflt: true,
+    editTypeOverride: 'calc'
+}), {
+    colorbar: colorbarAttrs
+});
+
+var fromMesh3d = ['opacity', 'lightposition', 'lighting'];
+
+fromMesh3d.forEach(function(k) {
+    attrs[k] = mesh3dAttrs[k];
+});
+
+attrs.hoverinfo = extendFlat({}, baseAttrs.hoverinfo, {
+    editType: 'calc',
+    flags: ['x', 'y', 'z', 'intensity', 'text', 'name'],
+    dflt: 'x+y+z+intensity+text+name'
+});
+
+module.exports = attrs;

src/traces/volume/calc.js

@@ -0,0 +1,27 @@
+/**
+* Copyright 2012-2018, 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 colorscaleCalc = require('../../components/colorscale/calc');
+
+module.exports = function calc(gd, trace) {
+    var value = trace.value;
+    var len = value.length;
+    var vMax = -Infinity;
+    var vMin = Infinity;
+
+    for(var i = 0; i < len; i++) {
+        var v = value[i];
+        vMax = Math.max(vMax, v);
+        vMin = Math.min(vMin, v);
+    }
+
+    trace._vMax = vMax;
+    colorscaleCalc(trace, [vMin, vMax], '', 'c');
+};