Merge pull request #4814 from plotly/rangebreaks-ohlc

Handle rangebreak gaps in `candlestick` & `ohlc`

Author: archmoj

src/lib/search.js

@@ -12,6 +12,7 @@
 var isNumeric = require('fast-isnumeric');
 var loggers = require('./loggers');
 var identity = require('./identity');
+var BADNUM = require('../constants/numerical').BADNUM;
 
 // don't trust floating point equality - fraction of bin size to call
 // "on the line" and ensure that they go the right way specified by
@@ -72,22 +73,35 @@ exports.sorterDes = function(a, b) { return b - a; };
  */
 exports.distinctVals = function(valsIn) {
     var vals = valsIn.slice();  // otherwise we sort the original array...
-    vals.sort(exports.sorterAsc);
+    vals.sort(exports.sorterAsc); // undefined listed in the end - also works on IE11
 
-    var l = vals.length - 1;
-    var minDiff = (vals[l] - vals[0]) || 1;
-    var errDiff = minDiff / (l || 1) / 10000;
-    var v2 = [vals[0]];
+    var last;
+    for(last = vals.length - 1; last > -1; last--) {
+        if(vals[last] !== BADNUM) break;
+    }
+
+    var minDiff = (vals[last] - vals[0]) || 1;
+    var errDiff = minDiff / (last || 1) / 10000;
+    var newVals = [];
+    var preV;
+    for(var i = 0; i <= last; i++) {
+        var v = vals[i];
 
-    for(var i = 0; i < l; i++) {
         // make sure values aren't just off by a rounding error
-        if(vals[i + 1] > vals[i] + errDiff) {
-            minDiff = Math.min(minDiff, vals[i + 1] - vals[i]);
-            v2.push(vals[i + 1]);
+        var diff = v - preV;
+
+        if(preV === undefined) {
+            newVals.push(v);
+            preV = v;
+        } else if(diff > errDiff) {
+            minDiff = Math.min(minDiff, diff);
+
+            newVals.push(v);
+            preV = v;
         }
     }
 
-    return {vals: v2, minDiff: minDiff};
+    return {vals: newVals, minDiff: minDiff};
 };
 
 /**

test/image/baselines/axes_breaks-candlestick.png

@@ -0,0 +1,75 @@
+{
+    "data": [
+        {
+            "type": "candlestick",
+            "x": [
+                "2020-01-02 17:00",
+                "2020-01-02 17:10",
+                "2020-01-02 17:20",
+                "2020-01-02 17:30",
+                "2020-01-02 17:40",
+                "2020-01-02 17:50",
+                "2020-01-02 18:00",
+                "2020-01-02 18:10"
+            ],
+            "open": [
+                10,
+                10,
+                10,
+                10,
+                10,
+                10,
+                10,
+                10
+            ],
+            "high": [
+                12,
+                12,
+                12,
+                12,
+                12,
+                12,
+                12,
+                14
+            ],
+            "low": [
+                8,
+                8,
+                8,
+                8,
+                8,
+                8,
+                3,
+                8
+            ],
+            "close": [
+                12,
+                7,
+                11,
+                10.5,
+                9,
+                8.5,
+                3,
+                14
+            ]
+        }
+    ],
+    "layout": {
+        "width": 600,
+        "height": 400,
+        "title": {
+            "text": "Candlestick with rangebreaks"
+        },
+        "xaxis": {
+            "rangebreaks": [
+                {
+                    "pattern": "hour",
+                    "bounds": [
+                        18,
+                        9
+                    ]
+                }
+            ]
+        }
+    }
+}

test/image/baselines/axes_breaks-candlestick2.png

@@ -50,6 +50,8 @@ var list = [
     'autorange-tozero-rangemode',
     'axes_booleans',
     'axes_breaks',
+    'axes_breaks-candlestick',
+    'axes_breaks-candlestick2',
     'axes_breaks-finance',
     'axes_breaks-gridlines',
     'axes_breaks-night_autorange-reversed',
@@ -1078,6 +1080,8 @@ figs['automargin-title-standoff'] = require('@mocks/automargin-title-standoff');
 figs['autorange-tozero-rangemode'] = require('@mocks/autorange-tozero-rangemode');
 // figs['axes_booleans'] = require('@mocks/axes_booleans');
 figs['axes_breaks'] = require('@mocks/axes_breaks');
+figs['axes_breaks-candlestick'] = require('@mocks/axes_breaks-candlestick');
+figs['axes_breaks-candlestick2'] = require('@mocks/axes_breaks-candlestick2');
 figs['axes_breaks-finance'] = require('@mocks/axes_breaks-finance');
 figs['axes_breaks-gridlines'] = require('@mocks/axes_breaks-gridlines');
 figs['axes_breaks-night_autorange-reversed'] = require('@mocks/axes_breaks-night_autorange-reversed');