8000 fixes #621 - make x/y/z dependent error bar attributes

... by using utilizing component-to-schema logic, instead of punching the error bar attributes into the trace declarations.
plotly · etpinard · Mar 2, 2018 · Mar 1, 2018 · Mar 1, 2018 · Mar 1, 2018
commit b08c4020e74e1a2df028afd74f4ec44c44ea1430
diff --git a/src/components/errorbars/index.js b/src/components/errorbars/index.js
@@ -6,18 +6,57 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 'use strict';
 
-var errorBars = module.exports = {};
+var Lib = require('../../lib');
+var overrideAll = require('../../plot_api/edit_types').overrideAll;
+
+var attributes = require('./attributes');
+var calc = require('./calc');
+
+var xyAttrs = {
+    error_x: Lib.extendFlat({}, attributes),
+    error_y: Lib.extendFlat({}, attributes)
+};
+delete xyAttrs.error_x.copy_zstyle;
+delete xyAttrs.error_y.copy_zstyle;
+delete xyAttrs.error_y.copy_ystyle;
+
+var xyzAttrs = {
+    error_x: Lib.extendFlat({}, attributes),
+    error_y: Lib.extendFlat({}, attributes),
+    error_z: Lib.extendFlat({}, attributes)
+};
+delete xyzAttrs.error_x.copy_ystyle;
+delete xyzAttrs.error_y.copy_ystyle;
+delete xyzAttrs.error_z.copy_ystyle;
+delete xyzAttrs.error_z.copy_zstyle;
+
+module.exports = {
+    moduleType: 'component',
+    name: 'errorbars',
 
-errorBars.attributes = require('./attributes');
+    schema: {
+        traces: {
+            scatter: xyAttrs,
+            bar: xyAttrs,
+            histogram: xyAttrs,
+            scatter3d: overrideAll(xyzAttrs, 'calc', 'nested'),
+            scattergl: overrideAll(xyAttrs, 'calc', 'nested')
+        }
+    },
 
-errorBars.supplyDefaults = require('./defaults');
+    supplyDefaults: require('./defaults'),
 
-errorBars.calc = require('./calc');
+    calc: calc,
+    calcFromTrace: calcFromTrace,
 
-errorBars.calcFromTrace = function(trace, layout) {
+    plot: require('./plot'),
+    style: require('./style'),
+    hoverInfo: hoverInfo
+};
+
+function calcFromTrace(trace, layout) {
     var x = trace.x || [],
         y = trace.y || [],
         len = x.length || y.length;
@@ -33,19 +72,15 @@ errorBars.calcFromTrace = function(trace, layout) {
 
     calcdataMock[0].trace = trace;
 
-    errorBars.calc({
+    calc({
         calcdata: [calcdataMock],
         _fullLayout: layout
     });
 
     return calcdataMock;
-};
+}
 
-errorBars.plot = require('./plot');
-
-errorBars.style = require('./style');
-
-errorBars.hoverInfo = function(calcPoint, trace, hoverPoint) {
+function hoverInfo(calcPoint, trace, hoverPoint) {
     if((trace.error_y || {}).visible) {
         hoverPoint.yerr = calcPoint.yh - calcPoint.y;
         if(!trace.error_y.symmetric) hoverPoint.yerrneg = calcPoint.y - calcPoint.ys;
@@ -54,4 +89,4 @@ errorBars.hoverInfo = function(calcPoint, trace, hoverPoint) {
         hoverPoint.xerr = calcPoint.xh - calcPoint.x;
         if(!trace.error_x.symmetric) hoverPoint.xerrneg = calcPoint.x - calcPoint.xs;
     }
-};
+}
diff --git a/src/core.js b/src/core.js
@@ -68,6 +68,7 @@ exports.register([
     require('./components/rangeslider'),
     require('./components/rangeselector'),
     require('./components/grid'),
+    require('./components/errorbars')
 ]);
 
 // locales en and en-US are required for default behavior

diff --git a/src/traces/bar/attributes.js b/src/traces/bar/attributes.js
@@ -10,7 +10,6 @@
 
 var scatterAttrs = require('../scatter/attributes');
 var colorAttributes = require('../../components/colorscale/color_attributes');
-var errorBarAttrs = require('../../components/errorbars/attributes');
 var colorbarAttrs = require('../../components/colorbar/attributes');
 var fontAttrs = require('../../plots/font_attributes');
 
@@ -190,9 +189,6 @@ module.exports = {
     r: scatterAttrs.r,
     t: scatterAttrs.t,
 
-    error_y: errorBarAttrs,
-    error_x: errorBarAttrs,
-
     _deprecated: {
         bardir: {
             valType: 'enumerated',

diff --git a/src/traces/histogram/attributes.js b/src/traces/histogram/attributes.js
@@ -10,7 +10,6 @@
 
 var barAttrs = require('../bar/attributes');
 
-
 module.exports = {
     x: {
         valType: 'data_array',
@@ -194,9 +193,6 @@ module.exports = {
     selected: barAttrs.selected,
     unselected: barAttrs.unselected,
 
-    error_y: barAttrs.error_y,
-    error_x: barAttrs.error_x,
-
     _deprecated: {
         bardir: barAttrs._deprecated.bardir
     }

diff --git a/src/traces/scatter/attributes.js b/src/traces/scatter/attributes.js
@@ -9,7 +9,6 @@
 'use strict';
 
 var colorAttributes = require('../../components/colorscale/color_attributes');
-var errorBarAttrs = require('../../components/errorbars/attributes');
 var colorbarAttrs = require('../../components/colorbar/attributes');
 var fontAttrs = require('../../plots/font_attributes');
 var dash = require('../../components/drawing/attributes').dash;
@@ -490,8 +489,5 @@ module.exports = {
             'Please switch to *scatterpolar* trace type.',
             'Sets the angular coordinates.'
         ].join('')
-    },
-
-    error_y: errorBarAttrs,
-    error_x: errorBarAttrs
+    }
 };
diff --git a/src/traces/scatter3d/attributes.js b/src/traces/scatter3d/attributes.js
@@ -10,7 +10,6 @@
 
 var scatterAttrs = require('../scatter/attributes');
 var colorAttributes = require('../../components/colorscale/color_attributes');
-var errorBarAttrs = require('../../components/errorbars/attributes');
 var baseAttrs = require('../../plots/attributes');
 var DASHES = require('../../constants/gl3d_dashes');
 
@@ -169,10 +168,6 @@ var attrs = module.exports = overrideAll({
     textposition: extendFlat({}, scatterAttrs.textposition, {dflt: 'top center'}),
     textfont: scatterAttrs.textfont,
 
-    error_x: errorBarAttrs,
-    error_y: errorBarAttrs,
-    error_z: errorBarAttrs,
-
     hoverinfo: extendFlat({}, baseAttrs.hoverinfo)
 }, 'calc', 'nested');
 

diff --git a/src/traces/scattergl/attributes.js b/src/traces/scattergl/attributes.js
@@ -87,8 +87,6 @@ var attrs = module.exports = overrideAll({
         editType: 'calc'
     }),
 
-    error_y: scatterAttrs.error_y,
-    error_x: scatterAttrs.error_x
 }, 'calc', 'nested');
 
 attrs.x.editType = attrs.y.editType = attrs.x0.editType = attrs.y0.editType = 'calc+clearAxisTypes';
diff --git a/test/jasmine/tests/plotschema_test.js b/test/jasmine/tests/plotschema_test.js
@@ -317,6 +317,32 @@ describe('plot schema', function() {
         expect(plotSchema.frames.items.frames_entry).toBeDefined();
         expect(plotSchema.frames.items.frames_entry.role).toEqual('object');
     });
+
+    it('should list trace-dependent & direction-dependent error bar attributes', function() {
+        var scatterSchema = plotSchema.traces.scatter.attributes;
+        expect(scatterSchema.error_x.copy_ystyle).toBeDefined();
+        expect(scatterSchema.error_x.copy_ystyle.editType).toBe('plot');
+        expect(scatterSchema.error_x.copy_zstyle).toBeUndefined();
+        expect(scatterSchema.error_y.copy_ystyle).toBeUndefined();
+        expect(scatterSchema.error_y.copy_zstyle).toBeUndefined();
+
+        var scatter3dSchema = plotSchema.traces.scatter3d.attributes;
+        expect(scatter3dSchema.error_x.copy_ystyle).toBeUndefined();
+        expect(scatter3dSchema.error_x.copy_zstyle).toBeDefined();
+        expect(scatter3dSchema.error_x.copy_zstyle.editType).toBe('calc');
+        expect(scatter3dSchema.error_y.copy_ystyle).toBeUndefined();
+        expect(scatter3dSchema.error_y.copy_zstyle).toBeDefined();
+        expect(scatter3dSchema.error_y.copy_zstyle.editType).toBe('calc');
+        expect(scatter3dSchema.error_z.copy_ystyle).toBeUndefined();
+        expect(scatter3dSchema.error_z.copy_zstyle).toBeUndefined();
+
+        var scatterglSchema = plotSchema.traces.scattergl.attributes;
+        expect(scatterglSchema.error_x.copy_ystyle).toBeDefined();
+        expect(scatterglSchema.error_x.copy_ystyle.editType).toBe('calc');
+        expect(scatterglSchema.error_x.copy_zstyle).toBeUndefined();
+        expect(scatterglSchema.error_y.copy_ystyle).toBeUndefined();
+        expect(scatterglSchema.error_y.copy_zstyle).toBeUndefined();
+    });
 });
 
 describe('getTraceValObject', function() {