Skip to content

Fix bar lengths in milliseconds from base #4900

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 7 commits into from
Jun 5, 2020
Merged

Fix bar lengths in milliseconds from base #4900

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4a0b877
add image test for bar with x in milisecond and base
archmoj Jun 3, 2020
2087766
fix milliseconds not to depend on timezone
archmoj Jun 3, 2020
6155965
apply UTC time only to bar length for now
archmoj Jun 4, 2020
118dc82
add Gantt chart mock
archmoj Jun 4, 2020
bff79dc
add jasmine test to lock down issue 4558
archmoj Jun 4, 2020
2ae0fdf
fixups thanks to AJ review
archmoj Jun 5, 2020
bb5bec3
add simple early return
archmoj Jun 5, 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
18 changes: 13 additions & 5 deletions src/plots/cartesian/set_convert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ module.exports = function setConvert(ax, fullLayout) {
* - inserts a dummy arg so calendar is the 3rd arg (see notes below).
* - defaults to ax.calendar
*/
function dt2ms(v, _, calendar) {
function dt2ms(v, _, calendar, msUTC) {
// NOTE: Changed this behavior: previously we took any numeric value
// to be a ms, even if it was a string that could be a bare year.
// Now we convert it as a date if at all possible, and only try
Expand All @@ -103,7 +103,15 @@ module.exports = function setConvert(ax, fullLayout) {
// same logic as in Lib.ms2DateTime
var msecTenths = Math.floor(Lib.mod(v + 0.05, 1) * 10);
var msRounded = Math.round(v - msecTenths / 10);
ms = dateTime2ms(new Date(msRounded)) + msecTenths / 10;

var d = new Date(msRounded);
ms = dateTime2ms(d) + msecTenths / 10;
if(msUTC) {
// For now it is only used
// to fix bar length in milliseconds.
// It could be applied in other places in v2
ms += d.getTimezoneOffset() * ONEMIN;
}
} else return BADNUM;
}
return ms;
Expand Down Expand Up @@ -791,7 +799,7 @@ module.exports = function setConvert(ax, fullLayout) {
// the first letter of ax._id?)
// in case the expected data isn't there, make a list of
// integers based on the opposite data
ax.makeCalcdata = function(trace, axLetter) {
ax.makeCalcdata = function(trace, axLetter, msUTC) {
var arrayIn, arrayOut, i, len;

var axType = ax.type;
Expand All @@ -815,10 +823,10 @@ module.exports = function setConvert(ax, fullLayout) {

arrayOut = new Array(len);
for(i = 0; i < len; i++) {
arrayOut[i] = ax.d2c(arrayIn[i], 0, cal);
arrayOut[i] = ax.d2c(arrayIn[i], 0, cal, msUTC);
}
} else {
var v0 = ((axLetter + '0') in trace) ? ax.d2c(trace[axLetter + '0'], 0, cal) : 0;
var v0 = ((axLetter + '0') in trace) ? ax.d2c(trace[axLetter + '0'], 0, cal, false) : 0;
var dv = (trace['d' + axLetter]) ? Number(trace['d' + axLetter]) : 1;

// the opposing data, for size if we have x and dx etc
Expand Down
10 changes: 6 additions & 4 deletions src/traces/bar/calc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ module.exports = function calc(gd, trace) {
var ya = Axes.getFromId(gd, trace.yaxis || 'y');
var size, pos;

var msUTC = !!(trace.base || trace.base === 0);

if(trace.orientation === 'h') {
size = xa.makeCalcdata(trace, 'x');
pos = ya.makeCalcdata(trace, 'y');
size = xa.makeCalcdata(trace, 'x', msUTC);
pos = ya.makeCalcdata(trace, 'y', msUTC);
} else {
size = ya.makeCalcdata(trace, 'y');
pos = xa.makeCalcdata(trace, 'x');
size = ya.makeCalcdata(trace, 'y', msUTC);
pos = xa.makeCalcdata(trace, 'x', msUTC);
}

// create the "calculated data" to plot
Expand Down
Binary file added test/image/baselines/bar-with-milliseconds.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/bar_gantt-chart.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.
51 changes: 51 additions & 0 deletions test/image/mocks/bar-with-milliseconds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"data": [
{
"base": [
"2020-02-02 00:00"
],
"orientation": "h",
"type": "bar",
"x": [
86400000
],
"y": [
1
],
"yaxis": "y"
},
{
"base": [
"2020-02-02 00:00"
],
"orientation": "h",
"type": "bar",
"x": [
"1970-01-02 00:00"
],
"y": [
1
],
"yaxis": "y2"
}
],
"layout": {
"width": 800,
"height": 400,
"xaxis": {
"type": "date"
},
"yaxis": {
"domain": [
0,
0.45
]
},
"yaxis2": {
"domain": [
0.55,
1
]
}
}
}
90 changes: 90 additions & 0 deletions test/image/mocks/bar_gantt-chart.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
{
"data": [
{
"base": [
"2020-03-01",
"2020-03-05",
"2020-03-05",
"2020-03-01",
"2020-03-06",
"2020-03-01",
"2020-03-07",
"2020-03-08",
"2020-03-09"
],
"orientation": "h",
"type": "bar",
"x": [
345600000,
172800000,
259200000,
432000000,
86400000,
518400000,
302400000,
86400000,
172800000
],
"marker": {
"colorscale": "Portland",
"color": [
1,
0,
1,
0,
0,
0.9,
0.3,
1,
1
]
},
"y": [
"Activity A",
"Activity B",
"Activity C",
"Activity D",
"Activity E",
"Activity F",
"Activity X",
"Activity Y",
"Activity Z"
],
"text": [
"4 days",
"2 days",
"3 days",
"5 days",
"1 day",
"6 days",
"3½ days",
"1 day",
"2 days"
],
"textfont": { "size": 16 },
"textposition": "inside",
"insidetextanchor": "middle",
"hovertemplate": "%{y}<br>start: %{base}<br>duration: %{text}<br>end: %{x}"
}
],
"layout": {
"width": 1000,
"height": 500,
"title": {
"text": "Gantt chart using Plotly.js bar"
},
"xaxis": {
"gridwidth": 5,
"tickwidth": 5,
"ticklen": 10,
"type": "date"
},
"yaxis": {
"tickfont": {
"family": "Times New Roman",
"size": 16
},
"autorange": "reversed"
}
}
}
20 changes: 20 additions & 0 deletions test/jasmine/tests/bar_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2600,6 +2600,26 @@ describe('bar hover', function() {
});
});
});

describe('gantt chart using milliseconds from base', function() {
beforeAll(function(done) {
gd = createGraphDiv();

var mock = Lib.extendDeep({}, require('@mocks/bar-with-milliseconds.json'));

Plotly.newPlot(gd, mock.data, mock.layout)
.catch(failTest)
.then(done);
});

it('should display the correct bar length passed in milliseconds from base', function() {
var out = _hover(gd, 0.5, 0.75, 'y');

var xEnd = out.style[2];
expect(xEnd).not.toBe(1580670000000);
expect(xEnd).toBe(1580688000000);
Copy link
Collaborator

Choose a reason for hiding this comment

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

If you're testing toBe, what do you gain from testing not.toBe? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just to ensure no one change the test.

});
});
});

describe('Text templates on bar traces:', function() {
Expand Down
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 @@ -111,6 +111,7 @@ var list = [
'bar_display_height_zero_no_line_width',
'bar_display_height_zero_only_line_width',
'bar_errorbars_inherit_color',
'bar_gantt-chart',
'bar_group_percent',
'bar_hide_nulls',
'bar_line',
Expand All @@ -137,6 +138,7 @@ var list = [
'bar-like_traces_tozero',
'bar-marker-line-colorscales',
'bar-offsetgroups',
'bar-with-milliseconds',
'basic_area',
'basic_bar',
'basic_error_bar',
Expand Down Expand Up @@ -1150,6 +1152,7 @@ figs['bar_display_height_zero'] = require('@mocks/bar_display_height_zero');
figs['bar_display_height_zero_no_line_width'] = require('@mocks/bar_display_height_zero_no_line_width');
figs['bar_display_height_zero_only_line_width'] = require('@mocks/bar_display_height_zero_only_line_width');
figs['bar_errorbars_inherit_color'] = require('@mocks/bar_errorbars_inherit_color');
figs['bar_gantt-chart'] = require('@mocks/bar_gantt-chart');
figs['bar_group_percent'] = require('@mocks/bar_group_percent');
figs['bar_hide_nulls'] = require('@mocks/bar_hide_nulls');
figs['bar_line'] = require('@mocks/bar_line');
Expand All @@ -1176,6 +1179,7 @@ figs['bar-like_traces_no-tozero_stack'] = require('@mocks/bar-like_traces_no-toz
figs['bar-like_traces_tozero'] = require('@mocks/bar-like_traces_tozero');
figs['bar-marker-line-colorscales'] = require('@mocks/bar-marker-line-colorscales');
figs['bar-offsetgroups'] = require('@mocks/bar-offsetgroups');
figs['bar-with-milliseconds'] = require('@mocks/bar-with-milliseconds');
figs['basic_area'] = require('@mocks/basic_area');
figs['basic_bar'] = require('@mocks/basic_bar');
figs['basic_error_bar'] = require('@mocks/basic_error_bar');
Expand Down