finance: add common 'line' style container

- trace-wide 'line' style sets default for
  increasing / decreasing line styling

Author: etpinard

src/traces/candlestick/attributes.js

@@ -17,8 +17,11 @@ var directionAttrs = {
     name: OHLCattrs.increasing.name,
     showlegend: OHLCattrs.increasing.showlegend,
 
-    color: Lib.extendFlat({}, boxAttrs.line.color),
-    width: Lib.extendFlat({}, boxAttrs.line.width),
+    line: {
+        color: Lib.extendFlat({}, boxAttrs.line.color),
+        width: Lib.extendFlat({}, boxAttrs.line.width)
+    },
+
     fillcolor: Lib.extendFlat({}, boxAttrs.fillcolor),
 };
 
@@ -29,14 +32,25 @@ module.exports = {
     low: OHLCattrs.low,
     close: OHLCattrs.close,
 
+    line: {
+        width: Lib.extendFlat({}, boxAttrs.line.width, {
+            description: [
+                boxAttrs.line.width.description,
+                'Note that this style setting can also be set per',
+                'direction via `increasing.line.width` and',
+                '`decreasing.line.width`.'
+            ].join(' ')
+        })
+    },
+
     increasing: Lib.extendDeep({}, directionAttrs, {
-        color: { dflt: OHLCattrs.increasing.color.dflt }
+        line: { color: { dflt: OHLCattrs.increasing.line.color.dflt } }
     }),
 
     decreasing: Lib.extendDeep({}, directionAttrs, {
-        color: { dflt: OHLCattrs.decreasing.color.dflt }
+        line: { color: { dflt: OHLCattrs.decreasing.line.color.dflt } }
     }),
 
     text: OHLCattrs.text,
-    whiskerwidth: Lib.extendFlat({}, boxAttrs.whiskerwidth, { dflt: 0 }),
+    whiskerwidth: Lib.extendFlat({}, boxAttrs.whiskerwidth, { dflt: 0 })
 };

src/traces/candlestick/defaults.js

@@ -28,17 +28,19 @@ module.exports = function supplyDefaults(traceIn, traceOut) {
         return;
     }
 
-    coerce('text');
-    coerce('whiskerwidth');
+    coerce('line.width');
 
     handleDirection(traceIn, traceOut, coerce, 'increasing');
     handleDirection(traceIn, traceOut, coerce, 'decreasing');
+
+    coerce('text');
+    coerce('whiskerwidth');
 };
 
 function handleDirection(traceIn, traceOut, coerce, direction) {
     handleDirectionDefaults(traceIn, traceOut, coerce, direction);
 
-    coerce(direction + '.color');
-    coerce(direction + '.width');
+    coerce(direction + '.line.color');
+    coerce(direction + '.line.width', traceOut.line.width);
     coerce(direction + '.fillcolor');
 }

src/traces/candlestick/transform.js

@@ -79,12 +79,7 @@ function makeTrace(traceIn, state, direction) {
 
             name: directionOpts.name,
             showlegend: directionOpts.showlegend,
-
-            line: {
-                color: directionOpts.color,
-                width: directionOpts.width
-            },
-
+            line: directionOpts.line,
             fillcolor: directionOpts.fillcolor
         });
     }

src/traces/ohlc/attributes.js

@@ -37,9 +37,11 @@ var directionAttrs = {
         ].join(' ')
     },
 
-    color: Lib.extendFlat({}, lineAttrs.color),
-    width: Lib.extendFlat({}, lineAttrs.width),
-    dash: Lib.extendFlat({}, lineAttrs.dash),
+    line: {
+        color: Lib.extendFlat({}, lineAttrs.color),
+        width: Lib.extendFlat({}, lineAttrs.width),
+        dash: Lib.extendFlat({}, lineAttrs.dash),
+    }
 };
 
 module.exports = {
@@ -76,12 +78,31 @@ module.exports = {
         description: 'Sets the close values.'
     },
 
+    line: {
+        width: Lib.extendFlat({}, lineAttrs.width, {
+            description: [
+                lineAttrs.width,
+                'Note that this style setting can also be set per',
+                'direction via `increasing.line.width` and',
+                '`decreasing.line.width`.'
+            ].join(' ')
+        }),
+        dash: Lib.extendFlat({}, lineAttrs.dash, {
+            description: [
+                lineAttrs.dash,
+                'Note that this style setting can also be set per',
+                'direction via `increasing.line.dash` and',
+                '`decreasing.line.dash`.'
+            ].join(' ')
+        }),
+    },
+
     increasing: Lib.extendDeep({}, directionAttrs, {
-        color: { dflt: INCREASING_COLOR }
+        line: { color: { dflt: INCREASING_COLOR } }
     }),
 
     decreasing: Lib.extendDeep({}, directionAttrs, {
-        color: { dflt: DECREASING_COLOR }
+        line: { color: { dflt: DECREASING_COLOR } }
     }),
 
     text: {

src/traces/ohlc/defaults.js

@@ -28,17 +28,20 @@ module.exports = function supplyDefaults(traceIn, traceOut) {
         return;
     }
 
-    coerce('text');
-    coerce('tickwidth');
+    coerce('line.width');
+    coerce('line.dash');
 
     handleDirection(traceIn, traceOut, coerce, 'increasing');
     handleDirection(traceIn, traceOut, coerce, 'decreasing');
+
+    coerce('text');
+    coerce('tickwidth');
 };
 
 function handleDirection(traceIn, traceOut, coerce, direction) {
     handleDirectionDefaults(traceIn, traceOut, coerce, direction);
 
-    coerce(direction + '.color');
-    coerce(direction + '.width');
-    coerce(direction + '.dash');
+    coerce(direction + '.line.color');
+    coerce(direction + '.line.width', traceOut.line.width);
+    coerce(direction + '.line.dash', traceOut.line.dash);
 }

src/traces/ohlc/transform.js

@@ -81,12 +81,7 @@ function makeTrace(traceIn, state, direction) {
 
             name: directionOpts.name,
             showlegend: directionOpts.showlegend,
-
-            line: {
-                color: directionOpts.color,
-                width: directionOpts.width,
-                dash: directionOpts.dash
-            }
+            line: directionOpts.line
         });
     }
 

test/jasmine/tests/finance_test.js

@@ -220,6 +220,41 @@ describe('finance charts defaults:', function() {
         ]);
     });
 
+    it('trace-wide styling should set default for corresponding per-direction styling', function() {
+        function assertLine(cont, width, dash) {
+            expect(cont.line.width).toEqual(width);
+            if(dash) expect(cont.line.dash).toEqual(dash);
+        }
+
+        var trace0 = Lib.extendDeep({}, mock0, {
+            type: 'ohlc',
+            line: { width: 1, dash: 'dash' },
+            decreasing: { line: { dash: 'dot' } }
+        });
+
+        var trace1 = Lib.extendDeep({}, mock1, {
+            type: 'candlestick',
+            line: { width: 3 },
+            increasing: { line: { width: 0 } }
+        });
+
+        var out = _supply([trace0, trace1]);
+
+
+        var fullData = out._fullData;
+        var fullInput = fullData.map(function(fullTrace) { return fullTrace._fullInput; });
+
+        assertLine(fullInput[0].increasing, 1, 'dash');
+        assertLine(fullInput[0].decreasing, 1, 'dot');
+        assertLine(fullInput[2].increasing, 0);
+        assertLine(fullInput[2].decreasing, 3);
+
+        assertLine(fullData[0], 1, 'dash');
+        assertLine(fullData[1], 1, 'dot');
+        assertLine(fullData[2], 0);
+        assertLine(fullData[3], 3);
+    });
+
     it('trace-wide *visible* should be passed to generated traces', function() {
         var trace0 = Lib.extendDeep({}, mock0, {
             type: 'ohlc',