finance: 2nd iteration

- factor out hacky moves in ohlc/helpers.js
- pass open, high, low, close array in transform opts,
  then pass then to traceOut in transform supplyDefaults
- use trace (not trace._fullInput) to filter ->
  this makes ohlc and candlestick compatible with filters & groupby

Author: etpinard

src/traces/candlestick/defaults.js

@@ -11,6 +11,7 @@
 
 var Lib = require('../../lib');
 var handleOHLC = require('../ohlc/ohlc_defaults');
+var helpers = require('../ohlc/helpers');
 var attributes = require('./attributes');
 
 module.exports = function supplyDefaults(traceIn, traceOut) {
@@ -19,13 +20,10 @@ module.exports = function supplyDefaults(traceIn, traceOut) {
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    // add comment about this hack block
     var transformOpts = { type: 'candlestick' };
-    if(Array.isArray(traceOut.transforms)) traceOut.transforms.push(transformOpts);
-    else traceOut.transforms = [transformOpts];
+    helpers.prependTransformOpts(traceIn, traceOut, transformOpts);
 
     var len = handleOHLC(traceIn, traceOut, coerce);
-
     if(len === 0) {
         traceOut.visible = false;
         return;

src/traces/candlestick/transform.js

@@ -9,7 +9,6 @@
 
 'use strict';
 
-var Lib = require('../../lib');
 var helpers = require('../ohlc/helpers');
 
 exports.moduleType = 'transform';
@@ -18,7 +17,11 @@ exports.name = 'candlestick';
 
 exports.attributes = {};
 
-exports.supplyDefaults = null;
+exports.supplyDefaults = function(transformIn, traceOut) {
+    helpers.copyOHLC(transformIn, traceOut);
+
+    return transformIn;
+};
 
 exports.transform = function transform(dataIn, state) {
     var dataOut = [];
@@ -45,82 +48,74 @@ exports.transform = function transform(dataIn, state) {
 };
 
 function makeTrace(traceIn, state, direction) {
-    var directionOpts = traceIn[direction];
-
-    // We need to track which direction ('increasing' or 'decreasing')
-    // the generated correspond to for the calcTransform step.
-    //
-    // To make sure that direction reaches the calcTransform,
-    // store it in the transform opts object.
-    var _transforms = Lib.extendFlat([], traceIn.transforms);
-    _transforms[state.transformIndex] = {
-        type: 'candlestick',
-        direction: direction
-    };
-
-    return {
+    var traceOut = {
         type: 'box',
         boxpoints: false,
 
         // TODO could do better
         name: direction,
 
-        // to make autotype catch date axes soon!!
-        x: traceIn.t || [0],
-
-        // concat low and high to get correct autorange
-        y: [].concat(traceIn.low).concat(traceIn.high),
-
-        visible: directionOpts.visible,
-
-        line: {
-            color: directionOpts.color,
-            width: directionOpts.width
-        },
-        fillcolor: directionOpts.fillcolor,
-
         // TODO this doesn't restyle currently
-        whiskerwidth: directionOpts.tickwidth,
+        whiskerwidth: traceIn.whiskerwidth,
 
         text: traceIn.text,
         hoverinfo: traceIn.hoverinfo,
 
         opacity: traceIn.opacity,
         showlegend: traceIn.showlegend,
 
-        transforms: _transforms
+        transforms: helpers.makeTransform(traceIn, state, direction)
     };
-}
 
-exports.calcTransform = function calcTransform(gd, trace, opts) {
-    var fullInput = trace._fullInput,
-        direction = opts.direction;
+    // the rest of below may not have been coerced
 
-    var filterFn = helpers.getFilterFn(direction);
+    var directionOpts = traceIn[direction];
 
-    var open = fullInput.open,
-        high = fullInput.high,
-        low = fullInput.low,
-        close = fullInput.close;
+    if(directionOpts) {
 
-    // sliced accordingly in supply-defaults
-    var len = open.length;
+        // to make autotype catch date axes soon!!
+        traceOut.x = traceIn.x || [0];
+
+        // concat low and high to get correct autorange
+        traceOut.y = [].concat(traceIn.low).concat(traceIn.high);
+
+        traceOut.visible = directionOpts.visible;
+
+        traceOut.line = {
+            color: directionOpts.color,
+            width: directionOpts.width
+        };
 
-    // clear generated trace x / y
-    trace.x = [];
-    trace.y = [];
+        traceOut.fillcolor = directionOpts.fillcolor;
+    }
+
+    return traceOut;
+}
+
+exports.calcTransform = function calcTransform(gd, trace, opts) {
+    var direction = opts.direction,
+        filterFn = helpers.getFilterFn(direction);
+
+    var open = trace.open,
+        high = trace.high,
+        low = trace.low,
+        close = trace.close;
 
-    var appendX = fullInput.t ?
+    var len = open.length,
+        x = [],
+        y = [];
+
+    var appendX = trace._fullInput.x ?
         function(i) {
-            var t = fullInput.t[i];
-            trace.x.push(t, t, t, t, t, t);
+            var v = trace.x[i];
+            x.push(v, v, v, v, v, v);
         } :
         function(i) {
-            trace.x.push(i, i, i, i, i, i);
+            x.push(i, i, i, i, i, i);
         };
 
     var appendY = function(o, h, l, c) {
-        trace.y.push(l, o, c, c, c, h);
+        y.push(l, o, c, c, c, h);
     };
 
     for(var i = 0; i < len; i++) {
@@ -129,4 +124,7 @@ exports.calcTransform = function calcTransform(gd, trace, opts) {
             appendY(open[i], high[i], low[i], close[i]);
         }
     }
+
+    trace.x = x;
+    trace.y = y;
 };

src/traces/ohlc/defaults.js

@@ -12,21 +12,18 @@
 var Lib = require('../../lib');
 var handleOHLC = require('./ohlc_defaults');
 var attributes = require('./attributes');
+var helpers = require('./helpers');
 
 module.exports = function supplyDefaults(traceIn, traceOut) {
 
     function coerce(attr, dflt) {
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    // TODO .. HAVE TO TEST FILTER with 't', 'high', 'open', 'low' ...
-
     var transformOpts = { type: 'ohlc' };
-    if(Array.isArray(traceOut.transforms)) traceOut.transforms.push(transformOpts);
-    else traceOut.transforms = [transformOpts];
+    helpers.prependTransformOpts(traceIn, traceOut, transformOpts);
 
     var len = handleOHLC(traceIn, traceOut, coerce);
-
     if(len === 0) {
         traceOut.visible = false;
         return;

src/traces/ohlc/helpers.js

@@ -9,8 +9,49 @@
 
 'use strict';
 
+var Lib = require('../../lib');
 
-exports.getFilterFn = function getFilterFn(direction) {
+// TODO add comment
+exports.prependTransformOpts = function(traceIn, traceOut, transformOpts) {
+    if(Array.isArray(traceIn.transforms)) {
+        traceIn.transforms.push(transformOpts);
+    }
+    else {
+        traceIn.transforms = [transformOpts];
+    }
+};
+
+// TODO add comment
+exports.copyOHLC = function(container, traceOut) {
+    if(container.open) traceOut.open = container.open;
+    if(container.high) traceOut.high = container.high;
+    if(container.low) traceOut.low = container.low;
+    if(container.close) traceOut.close = container.close;
+};
+
+// We need to track which direction ('increasing' or 'decreasing')
+// the generated correspond to for the calcTransform step.
+//
+// To make sure that direction reaches the calcTransform,
+// store it in the transform opts object.
+exports.makeTransform = function(traceIn, state, direction) {
+    var out = Lib.extendFlat([], traceIn.transforms);
+
+    out[state.transformIndex] = {
+        type: traceIn.type,
+        direction: direction,
+
+        // ...
+        open: traceIn.open,
+        high: traceIn.high,
+        low: traceIn.low,
+        close: traceIn.close
+    };
+
+    return out;
+};
+
+exports.getFilterFn = function(direction) {
     switch(direction) {
         case 'increasing':
             return function(o, c) { return o <= c; };
@@ -20,7 +61,7 @@ exports.getFilterFn = function getFilterFn(direction) {
     }
 };
 
-exports.addRangeSlider = function addRangeSlider(layout) {
+exports.addRangeSlider = function(layout) {
     if(!layout.xaxis) layout.xaxis = {};
     if(!layout.xaxis.rangeslider) layout.xaxis.rangeslider = {};
 };