Skip to content

fix(scale.time): respect per-unit displayFormat in getLabelForValue #12276

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

Open
xianjianlf2 wants to merge 1 commit into
base: master
Choose a base branch
from
+45 −5
Open

fix(scale.time): respect per-unit displayFormat in getLabelForValue #12276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/scales/scale.time.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,8 @@ export default class TimeScale extends Scale {
if (timeOpts.tooltipFormat) {
return adapter.format(value, timeOpts.tooltipFormat);
}
return adapter.format(value, timeOpts.displayFormats.datetime);
const displayFormats = timeOpts.displayFormats;
return adapter.format(value, displayFormats[this._unit] || displayFormats.datetime);
}

/**
Expand Down
47 changes: 43 additions & 4 deletions test/specs/scale.time.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,8 +329,45 @@ describe('Time scale tests', function() {
var xScale = chart.scales.x;
var controller = chart.getDatasetMeta(0).controller;
expect(xScale.getLabelForValue(controller.getParsed(0)[xScale.id])).toBeTruthy();
expect(xScale.getLabelForValue(controller.getParsed(0)[xScale.id])).toBe('Jan 1, 2015, 8:00:00 pm');
expect(xScale.getLabelForValue(xScale.getValueForPixel(xScale.getPixelForTick(6)))).toBe('Jan 10, 2015, 12:00:00 pm');
// getLabelForValue uses the displayFormat of the current unit ('day' here), see #12128
expect(xScale.getLabelForValue(controller.getParsed(0)[xScale.id])).toBe('Jan 1');
expect(xScale.getLabelForValue(xScale.getValueForPixel(xScale.getPixelForTick(6)))).toBe('Jan 10');
});

it('should format getLabelForValue with the displayFormat of the current unit (#12128)', function() {
var chart = window.acquireChart({
type: 'line',
data: {
datasets: [{
xAxisID: 'x',
data: [{x: '2015-01-01T20:00:00', y: 10}, {x: '2015-01-02T21:00:00', y: 3}]
}]
},
options: {
scales: {
x: {
type: 'time',
time: {
unit: 'day',
displayFormats: {
day: 'YYYY-MM-DD'
}
}
}
}
}
});

var xScale = chart.scales.x;
var value = chart.getDatasetMeta(0).controller.getParsed(0)[xScale.id];

// Previously getLabelForValue always used the `datetime` displayFormat, ignoring
// the configured format of the current unit ('day'). See #12128.
expect(xScale.getLabelForValue(value)).toBe('2015-01-01');

// tooltipFormat still takes precedence over the unit displayFormat.
xScale.options.time.tooltipFormat = 'YYYY/MM/DD HH:mm';
expect(xScale.getLabelForValue(value)).toBe('2015/01/01 20:00');
});

describe('when ticks.callback is specified', function() {
Expand Down Expand Up @@ -410,7 +447,8 @@ describe('Time scale tests', function() {
var controller = chart.getDatasetMeta(0).controller;
var value = controller.getParsed(0)[xScale.id];
expect(xScale.getLabelForValue(value)).toBeTruthy();
expect(xScale.getLabelForValue(value)).toBe('Jan 1, 2015, 8:00:00 pm');
// getLabelForValue uses the displayFormat of the current unit ('hour' here), see #12128
expect(xScale.getLabelForValue(value)).toBe('8PM');
});

it('should get the correct label for a data value by format', function() {
Expand Down Expand Up @@ -516,7 +554,8 @@ describe('Time scale tests', function() {
var xScale = chart.scales.x;
var controller = chart.getDatasetMeta(0).controller;
var label = xScale.getLabelForValue(controller.getParsed(0)[xScale.id]);
expect(label).toEqual('Jan 8, 2018, 5:14:23 am');
// getLabelForValue uses the displayFormat of the current unit ('hour' here), see #12128
expect(label).toEqual('5AM');
});

it('should get the correct pixel for only one data in the dataset', function() {
Expand Down