finance: improve inc / dec 'name' / 'showlegend' logic

- remove `increasing/decreasing.visible` attribute
- add increasing/decreasing 'name' and 'showlegend'

Author: etpinard

src/traces/candlestick/attributes.js

@@ -14,15 +14,8 @@ var OHLCattrs = require('../ohlc/attributes');
 var boxAttrs = require('../box/attributes');
 
 var directionAttrs = {
-    visible: {
-        valType: 'enumerated',
-        values: [true, false, 'legendonly'],
-        role: 'info',
-        dflt: true,
-        description: [
-
-        ].join(' ')
-    },
+    name: OHLCattrs.increasing.name,
+    showlegend: OHLCattrs.increasing.showlegend,
 
     color: Lib.extendFlat({}, boxAttrs.line.color),
     width: Lib.extendFlat({}, boxAttrs.line.width),

src/traces/candlestick/defaults.js

@@ -11,6 +11,7 @@
 
 var Lib = require('../../lib');
 var handleOHLC = require('../ohlc/ohlc_defaults');
+var handleDirectionDefaults = require('../ohlc/direction_defaults');
 var helpers = require('../ohlc/helpers');
 var attributes = require('./attributes');
 
@@ -30,16 +31,14 @@ module.exports = function supplyDefaults(traceIn, traceOut) {
     coerce('text');
     coerce('whiskerwidth');
 
-    handleDirection(traceOut, coerce, 'increasing');
-    handleDirection(traceOut, coerce, 'decreasing');
+    handleDirection(traceIn, traceOut, coerce, 'increasing');
+    handleDirection(traceIn, traceOut, coerce, 'decreasing');
 };
 
-function handleDirection(traceOut, coerce, direction) {
-    var dirVisible = coerce(direction + '.visible', traceOut.visible);
+function handleDirection(traceIn, traceOut, coerce, direction) {
+    handleDirectionDefaults(traceIn, traceOut, coerce, direction);
 
-    if(dirVisible) {
-        coerce(direction + '.color');
-        coerce(direction + '.width');
-        coerce(direction + '.fillcolor');
-    }
+    coerce(direction + '.color');
+    coerce(direction + '.width');
+    coerce(direction + '.fillcolor');
 }

src/traces/candlestick/transform.js

@@ -9,6 +9,7 @@
 
 'use strict';
 
+var Lib = require('../../lib');
 var helpers = require('../ohlc/helpers');
 
 exports.moduleType = 'transform';
@@ -52,17 +53,9 @@ function makeTrace(traceIn, state, direction) {
         type: 'box',
         boxpoints: false,
 
-        // TODO could do better
-        name: direction,
-
-        // TODO this doesn't restyle currently
-        whiskerwidth: traceIn.whiskerwidth,
-
-        text: traceIn.text,
+        visible: traceIn.visible,
         hoverinfo: traceIn.hoverinfo,
-
         opacity: traceIn.opacity,
-        showlegend: traceIn.showlegend,
 
         transforms: helpers.makeTransform(traceIn, state, direction)
     };
@@ -72,21 +65,27 @@ function makeTrace(traceIn, state, direction) {
     var directionOpts = traceIn[direction];
 
     if(directionOpts) {
+        Lib.extendFlat(traceOut, {
 
-        // to make autotype catch date axes soon!!
-        traceOut.x = traceIn.x || [0];
+            // to make autotype catch date axes soon!!
+            x: traceIn.x || [0],
 
-        // concat low and high to get correct autorange
-        traceOut.y = [].concat(traceIn.low).concat(traceIn.high);
+            // concat low and high to get correct autorange
+            y: [].concat(traceIn.low).concat(traceIn.high),
 
-        traceOut.visible = directionOpts.visible;
+            whiskerwidth: traceIn.whiskerwidth,
+            text: traceIn.text,
 
-        traceOut.line = {
-            color: directionOpts.color,
-            width: directionOpts.width
-        };
+            name: directionOpts.name,
+            showlegend: directionOpts.showlegend,
+
+            line: {
+                color: directionOpts.color,
+                width: directionOpts.width
+            },
 
-        traceOut.fillcolor = directionOpts.fillcolor;
+            fillcolor: directionOpts.fillcolor
+        });
     }
 
     return traceOut;

src/traces/ohlc/attributes.js

@@ -18,13 +18,22 @@ var DECREASING_COLOR = '#FF4136';
 var lineAttrs = scatterAttrs.line;
 
 var directionAttrs = {
-    visible: {
-        valType: 'enumerated',
-        values: [true, false, 'legendonly'],
+    name: {
+        valType: 'string',
         role: 'info',
-        dflt: true,
         description: [
+            'Sets the segment name.',
+            'The segment name appear as the legend item and on hover.'
+        ].join(' ')
+    },
 
+    showlegend: {
+        valType: 'boolean',
+        role: 'info',
+        dflt: true,
+        description: [
+            'Determines whether or not an item corresponding to this',
+            'segment is shown in the legend.'
         ].join(' ')
     },
 

src/traces/ohlc/defaults.js

@@ -11,6 +11,7 @@
 
 var Lib = require('../../lib');
 var handleOHLC = require('./ohlc_defaults');
+var handleDirectionDefaults = require('./direction_defaults');
 var attributes = require('./attributes');
 var helpers = require('./helpers');
 
@@ -30,16 +31,14 @@ module.exports = function supplyDefaults(traceIn, traceOut) {
     coerce('text');
     coerce('tickwidth');
 
-    handleDirection(traceOut, coerce, 'increasing');
-    handleDirection(traceOut, coerce, 'decreasing');
+    handleDirection(traceIn, traceOut, coerce, 'increasing');
+    handleDirection(traceIn, traceOut, coerce, 'decreasing');
 };
 
-function handleDirection(traceOut, coerce, direction) {
-    var dirVisible = coerce(direction + '.visible', traceOut.visible);
+function handleDirection(traceIn, traceOut, coerce, direction) {
+    handleDirectionDefaults(traceIn, traceOut, coerce, direction);
 
-    if(dirVisible) {
-        coerce(direction + '.color');
-        coerce(direction + '.width');
-        coerce(direction + '.dash');
-    }
+    coerce(direction + '.color');
+    coerce(direction + '.width');
+    coerce(direction + '.dash');
 }

src/traces/ohlc/direction_defaults.js

@@ -0,0 +1,24 @@
+/**
+* Copyright 2012-2016, 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 = function handleDirectionDefaults(traceIn, traceOut, coerce, direction) {
+    coerce(direction + '.showlegend');
+
+    // trace-wide *showlegend* overrides direction *showlegend*
+    if(traceIn.showlegend === false) {
+        traceOut[direction].showlegend = false;
+    }
+
+    var nameDflt = traceOut.name + ' - ' + direction;
+
+    coerce(direction + '.name', nameDflt);
+};

src/traces/ohlc/transform.js

@@ -9,6 +9,7 @@
 
 'use strict';
 
+var Lib = require('../../lib');
 var helpers = require('./helpers');
 var axisIds = require('../../plots/cartesian/axis_ids');
 
@@ -55,14 +56,9 @@ function makeTrace(traceIn, state, direction) {
         mode: 'lines',
         connectgaps: false,
 
-        // TODO could do better
-        name: direction,
-
-        text: traceIn.text,
+        visible: traceIn.visible,
         hoverinfo: traceIn.hoverinfo,
-
         opacity: traceIn.opacity,
-        showlegend: traceIn.showlegend,
 
         transforms: helpers.makeTransform(traceIn, state, direction)
     };
@@ -72,20 +68,25 @@ function makeTrace(traceIn, state, direction) {
     var directionOpts = traceIn[direction];
 
     if(directionOpts) {
+        Lib.extendFlat(traceOut, {
 
-        // to make autotype catch date axes soon!!
-        traceOut.x = traceIn.x || [0];
+            // to make autotype catch date axes soon!!
+            x: traceIn.x || [0],
 
-        // concat low and high to get correct autorange
-        traceOut.y = [].concat(traceIn.low).concat(traceIn.high);
+            // concat low and high to get correct autorange
+            y: [].concat(traceIn.low).concat(traceIn.high),
 
-        traceOut.visible = directionOpts.visible;
+            text: traceIn.text,
 
-        traceOut.line = {
-            color: directionOpts.color,
-            width: directionOpts.width,
-            dash: directionOpts.dash
-        };
+            name: directionOpts.name,
+            showlegend: directionOpts.showlegend,
+
+            line: {
+                color: directionOpts.color,
+                width: directionOpts.width,
+                dash: directionOpts.dash
+            }
+        });
     }
 
     return traceOut;