Skip to content

Fix rangebreaks on heatmap with 2d z array #4821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 11, 2020
Merged

Fix rangebreaks on heatmap with 2d z array #4821

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
de4ff4f
refactor heatmap convertColumnData
archmoj May 7, 2020
e85b04c
add heatmap rangebreak mocks with 1d & 2d z arrays
archmoj May 7, 2020
9051ab6
remove BADNUMs i.e. rangebreak gaps from heatmap trace.x & y and drop…
archmoj May 7, 2020
5f5f92d
correct baseline of heatmap with 2d-z-array
archmoj May 7, 2020
e2cf395
extend mock data to next day over the break
archmoj May 8, 2020
a7676bd
add tests for coutour with rangebreaks & 1d and 2d z array
archmoj May 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions src/traces/heatmap/calc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ var clean2dArray = require('./clean_2d_array');
var interp2d = require('./interp2d');
var findEmpties = require('./find_empties');
var makeBoundArray = require('./make_bound_array');
var BADNUM = require('../../constants/numerical').BADNUM;

module.exports = function calc(gd, trace) {
// prepare the raw data
Expand Down Expand Up @@ -71,6 +72,12 @@ module.exports = function calc(gd, trace) {

z = clean2dArray(zIn, trace, xa, ya);

if(xa.rangebreaks || ya.rangebreaks) {
z = dropZonBreaks(z, trace);
x = trace._x = skipBreaks(trace._x);
y = trace._y = skipBreaks(trace._y);
}

if(isContour || trace.connectgaps) {
trace._emptypoints = findEmpties(z);
interp2d(z, trace._emptypoints);
Expand Down Expand Up @@ -156,3 +163,29 @@ module.exports = function calc(gd, trace) {

return [cd0];
};

function skipBreaks(a) {
var b = [];
var len = a.length;
for(var i = 0; i < len; i++) {
var v = a[i];
if(v !== BADNUM) b.push(v);
}
return b;
}

function dropZonBreaks(z, trace) {
var newZ = [];
var k = -1;
for(var i = 0; i < z.length; i++) {
if(trace._y[i] === BADNUM) continue;
k++;
newZ[k] = [];
for(var j = 0; j < z[i].length; j++) {
if(trace._x[j] === BADNUM) continue;

newZ[k].push(z[i][j]);
}
}
return newZ;
}
11 changes: 7 additions & 4 deletions src/traces/heatmap/convert_column_xyz.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,21 @@ module.exports = function convertColumnData(trace, ax1, ax2, var1Name, var2Name,
var text;
var hovertext;

var nI = col2vals.length;
var nJ = col1vals.length;

for(i = 0; i < arrayVarNames.length; i++) {
newArrays[i] = Lib.init2dArray(col2vals.length, col1vals.length);
newArrays[i] = Lib.init2dArray(nI, nJ);
}

if(hasColumnText) {
text = Lib.init2dArray(col2vals.length, col1vals.length);
text = Lib.init2dArray(nI, nJ);
}
if(hasColumnHoverText) {
hovertext = Lib.init2dArray(col2vals.length, col1vals.length);
hovertext = Lib.init2dArray(nI, nJ);
}

var after2before = Lib.init2dArray(col2vals.length, col1vals.length);
var after2before = Lib.init2dArray(nI, nJ);

for(i = 0; i < colLen; i++) {
if(col1[i] !== BADNUM && col2[i] !== BADNUM) {
Expand Down
Binary file added test/image/baselines/axes_breaks-heatmap1d.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added test/image/baselines/axes_breaks-heatmap2d.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
111 changes: 111 additions & 0 deletions test/image/mocks/axes_breaks-heatmap1d.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
{
"data": [
{
"type": "heatmap",
"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",
"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",
"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",
"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",
"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",
"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",
"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",
"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"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tests include some removed data, which is good - but can we also include some data on the other side of the break, ie the next morning?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Done in e2cf395.

],
"y": [
1, 1, 1, 1, 1, 1, 1, 1,
2, 2, 2, 2, 2, 2, 2, 2,
3, 3, 3, 3, 3, 3, 3, 3,
4, 4, 4, 4, 4, 4, 4, 4,
5, 5, 5, 5, 5, 5, 5, 5,
6, 6, 6, 6, 6, 6, 6, 6,
7, 7, 7, 7, 7, 7, 7, 7,
8, 8, 8, 8, 8, 8, 8, 8
],
"z":[
1, 1, 1, 1, 1, 1, 1, 1,
1, 2, 1, 1, 1, 1, 2, 1,
1, 1, 3, 1, 1, 3, 1, 1,
1, 1, 1, 4, 4, 1, 1, 1,
1, 1, 1, 4, 4, 1, 1, 1,
1, 1, 3, 1, 1, 3, 1, 1,
1, 2, 1, 1, 1, 1, 2, 1,
1, 1, 1, 1, 1, 1, 1, 1
]
}
],
"layout": {
"width": 600,
"height": 400,
"title": {
"text": "1D-z-array heatmap with rangebreaks"
},
"xaxis": {
"rangebreaks": [
{
"pattern": "hour",
"bounds": [
18,
9
]
}
]
}
}
}
51 changes: 51 additions & 0 deletions test/image/mocks/axes_breaks-heatmap2d.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"data": [
{
"type": "heatmap",
"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"
],
"y": [
1,
2,
3,
4,
5,
6,
7,
8
],
"z": [
[1, 1, 1, 1, 1, 1, 1, 1],
[1, 2, 1, 1, 1, 1, 2, 1],
[1, 1, 3, 1, 1, 3, 1, 1],
[1, 1, 1, 4, 4, 1, 1, 1],
[1, 1, 1, 4, 4, 1, 1, 1],
[1, 1, 3, 1, 1, 3, 1, 1],
[1, 2, 1, 1, 1, 1, 2, 1],
[1, 1, 1, 1, 1, 1, 1, 1]
]
}
],
"layout": {
"width": 600,
"height": 400,
"title": {
"text": "2D-z-array heatmap with rangebreaks"
},
"xaxis": {
"rangebreaks": [
{
"pattern": "hour",
"bounds": [
18,
9
]
}
]
}
}
}
4 changes: 4 additions & 0 deletions test/jasmine/tests/mock_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ var list = [
'axes_breaks-candlestick2',
'axes_breaks-finance',
'axes_breaks-gridlines',
'axes_breaks-heatmap1d',
'axes_breaks-heatmap2d',
'axes_breaks-night_autorange-reversed',
'axes_breaks-rangeslider',
'axes_breaks-reversed-without-pattern',
Expand Down Expand Up @@ -1084,6 +1086,8 @@ 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-heatmap1d'] = require('@mocks/axes_breaks-heatmap1d');
figs['axes_breaks-heatmap2d'] = require('@mocks/axes_breaks-heatmap2d');
figs['axes_breaks-night_autorange-reversed'] = require('@mocks/axes_breaks-night_autorange-reversed');
figs['axes_breaks-rangeslider'] = require('@mocks/axes_breaks-rangeslider');
figs['axes_breaks-reversed-without-pattern'] = require('@mocks/axes_breaks-reversed-without-pattern');
Expand Down