Change `scale.ticks.bounds` to `scale.bounds` (#4595)

The `bounds` option makes more sense directly under `scale` since it defines the scale limits strategy when no explicit min/max are specified. Also change the `bounds: 'labels'` option value for `bounds: 'ticks'` because it really means: "ensure ticks to be fully visible in the scale, whatever the ticks `source`.

diff --git a/src/scales/scale.time.js b/src/scales/scale.time.js
index 4a07df496b1cd47bb2131642b282eb029e0e1074..8006b74df09b244606f5e8fea664cdcda658a063 100644 (file)
--- a/src/scales/scale.time.js
+++ b/src/scales/scale.time.js
@@ -361,6 +361,15 @@ module.exports = function(Chart) {
                 */
                distribution: 'linear',
 
+               /**
+                * Scale boundary strategy (bypassed by min/max time options)
+                * - `data`: make sure data are fully visible, ticks outside are removed
+                * - `ticks`: make sure ticks are fully visible, data outside are truncated
+                * @see https://github.com/chartjs/Chart.js/pull/4556
+                * @since 2.7.0
+                */
+               bounds: 'data',
+
                time: {
                        parser: false, // false == a pattern string from http://momentjs.com/docs/#/parsing/string-format/ or a custom callback that converts its argument to a moment
                        format: false, // DEPRECATED false == date objects, moment object, callback or a pattern string from http://momentjs.com/docs/#/parsing/string-format/
@@ -394,16 +403,7 @@ module.exports = function(Chart) {
                         * @see https://github.com/chartjs/Chart.js/pull/4507
                         * @since 2.7.0
                         */
-                       source: 'auto',
-
-                       /**
-                        * Ticks boundary strategy (bypassed by min/max time options)
-                        * - `data`: make sure data are fully visible, labels outside are removed
-                        * - `labels`: make sure labels are fully visible, data outside are truncated
-                        * @see https://github.com/chartjs/Chart.js/pull/4556
-                        * @since 2.7.0
-                        */
-                       bounds: 'data'
+                       source: 'auto'
                }
        };
 
@@ -520,7 +520,6 @@ module.exports = function(Chart) {
                        var max = me.max;
                        var options = me.options;
                        var timeOpts = options.time;
-                       var ticksOpts = options.ticks;
                        var formats = timeOpts.displayFormats;
                        var capacity = me.getLabelCapacity(min);
                        var unit = timeOpts.unit || determineUnit(timeOpts.minUnit, min, max, capacity);
@@ -529,7 +528,7 @@ module.exports = function(Chart) {
                        var ticks = [];
                        var i, ilen, timestamp;
 
-                       switch (ticksOpts.source) {
+                       switch (options.ticks.source) {
                        case 'data':
                                timestamps = me._timestamps.data;
                                break;
@@ -541,7 +540,7 @@ module.exports = function(Chart) {
                                timestamps = generate(min, max, unit, majorUnit, capacity, timeOpts);
                        }
 
-                       if (ticksOpts.bounds === 'labels' && timestamps.length) {
+                       if (options.bounds === 'ticks' && timestamps.length) {
                                min = timestamps[0];
                                max = timestamps[timestamps.length - 1];
                        }

diff --git a/test/specs/global.deprecations.tests.js b/test/specs/global.deprecations.tests.js
index a44fe539edba12673c565f0fbf810c374566b4c2..c5bef5b20b4725766a2df7682a80be0cbb94f98a 100644 (file)
--- a/test/specs/global.deprecations.tests.js
+++ b/test/specs/global.deprecations.tests.js
@@ -265,12 +265,10 @@ describe('Deprecations', function() {
                                                        xAxes: [{
                                                                id: 'time',
                                                                type: 'time',
+                                                               bounds: 'ticks',
                                                                time: {
                                                                        unit: 'hour',
                                                                        unitStepSize: 2
-                                                               },
-                                                               ticks: {
-                                                                       bounds: 'labels'
                                                                }
                                                        }]
                                                }

diff --git a/test/specs/scale.time.tests.js b/test/specs/scale.time.tests.js
index 91dc218008bbe7f0d15e1c85721fd775372f41e4..267c2b99a2bbfc926f050bb1003e193a52cea727 100755 (executable)
--- a/test/specs/scale.time.tests.js
+++ b/test/specs/scale.time.tests.js
@@ -77,6 +77,7 @@ describe('Time scale tests', function() {
                                labelString: '',
                                lineHeight: 1.2
                        },
+                       bounds: 'data',
                        distribution: 'linear',
                        ticks: {
                                beginAtZero: false,
@@ -84,7 +85,6 @@ describe('Time scale tests', function() {
                                maxRotation: 50,
                                mirror: false,
                                source: 'auto',
-                               bounds: 'data',
                                padding: 0,
                                reverse: false,
                                display: true,
@@ -137,7 +137,7 @@ describe('Time scale tests', function() {
                        scale.update(1000, 200);
                        var ticks = getTicksLabels(scale);
 
-                       // `ticks.bounds === 'data'`: first and last ticks removed since outside the data range
+                       // `bounds === 'data'`: first and last ticks removed since outside the data range
                        expect(ticks).toEqual(['Jan 2', 'Jan 3', 'Jan 4', 'Jan 5', 'Jan 6', 'Jan 7', 'Jan 8', 'Jan 9', 'Jan 10']);
                });
 
@@ -149,7 +149,7 @@ describe('Time scale tests', function() {
                        scale.update(1000, 200);
                        var ticks = getTicksLabels(scale);
 
-                       // `ticks.bounds === 'data'`: first and last ticks removed since outside the data range
+                       // `bounds === 'data'`: first and last ticks removed since outside the data range
                        expect(ticks).toEqual(['Jan 2', 'Jan 3', 'Jan 4', 'Jan 5', 'Jan 6', 'Jan 7', 'Jan 8', 'Jan 9', 'Jan 10']);
                });
 
@@ -198,7 +198,7 @@ describe('Time scale tests', function() {
                        xScale.update(800, 200);
                        var ticks = getTicksLabels(xScale);
 
-                       // `ticks.bounds === 'data'`: first and last ticks removed since outside the data range
+                       // `bounds === 'data'`: first and last ticks removed since outside the data range
                        expect(ticks).toEqual(['Jan 2', 'Jan 3', 'Jan 4', 'Jan 5', 'Jan 6', 'Jan 7', 'Jan 8', 'Jan 9', 'Jan 10']);
                });
 
@@ -247,7 +247,7 @@ describe('Time scale tests', function() {
                        tScale.update(800, 200);
                        var ticks = getTicksLabels(tScale);
 
-                       // `ticks.bounds === 'data'`: first and last ticks removed since outside the data range
+                       // `bounds === 'data'`: first and last ticks removed since outside the data range
                        expect(ticks).toEqual(['Jan 2', 'Jan 3', 'Jan 4', 'Jan 5', 'Jan 6', 'Jan 7', 'Jan 8', 'Jan 9', 'Jan 10']);
                });
        });
@@ -314,11 +314,9 @@ describe('Time scale tests', function() {
                };
 
                var config = Chart.helpers.mergeIf({
+                       bounds: 'ticks',
                        time: {
                                minUnit: 'day'
-                       },
-                       ticks: {
-                               bounds: 'labels'
                        }
                }, Chart.scaleService.getScaleDefaults('time'));
 
@@ -334,12 +332,10 @@ describe('Time scale tests', function() {
                };
 
                var config = Chart.helpers.mergeIf({
+                       bounds: 'ticks',
                        time: {
                                unit: 'week',
                                round: 'week'
-                       },
-                       ticks: {
-                               bounds: 'labels'
                        }
                }, Chart.scaleService.getScaleDefaults('time'));
 
@@ -358,12 +354,10 @@ describe('Time scale tests', function() {
                        };
 
                        var config = Chart.helpers.mergeIf({
+                               bounds: 'ticks',
                                time: {
                                        unit: 'hour',
                                        stepSize: 2
-                               },
-                               ticks: {
-                                       bounds: 'labels'
                                }
                        }, Chart.scaleService.getScaleDefaults('time'));
 
@@ -413,12 +407,10 @@ describe('Time scale tests', function() {
                };
 
                var config = Chart.helpers.mergeIf({
+                       bounds: 'ticks',
                        time: {
                                unit: 'week',
                                isoWeekday: 3 // Wednesday
-                       },
-                       ticks: {
-                               bounds: 'labels'
                        }
                }, Chart.scaleService.getScaleDefaults('time'));
 
@@ -505,10 +497,8 @@ describe('Time scale tests', function() {
                                                xAxes: [{
                                                        id: 'xScale0',
                                                        type: 'time',
-                                                       position: 'bottom',
-                                                       ticks: {
-                                                               bounds: 'labels'
-                                                       }
+                                                       bounds: 'ticks',
+                                                       position: 'bottom'
                                                }],
                                        }
                                }
@@ -943,7 +933,7 @@ describe('Time scale tests', function() {
                });
        });
 
-       describe('when ticks.bounds', function() {
+       describe('when bounds', function() {
                describe('is "data"', function() {
                        it ('should preserve the data range', function() {
                                var chart = window.acquireChart({
@@ -957,12 +947,10 @@ describe('Time scale tests', function() {
                                                        xAxes: [{
                                                                id: 'x',
                                                                type: 'time',
+                                                               bounds: 'data',
                                                                time: {
                                                                        parser: 'MM/DD HH:mm',
                                                                        unit: 'day'
-                                                               },
-                                                               ticks: {
-                                                                       bounds: 'data'
                                                                }
                                                        }],
                                                        yAxes: [{
@@ -996,12 +984,10 @@ describe('Time scale tests', function() {
                                                        xAxes: [{
                                                                id: 'x',
                                                                type: 'time',
+                                                               bounds: 'ticks',
                                                                time: {
                                                                        parser: 'MM/DD HH:mm',
                                                                        unit: 'day'
-                                                               },
-                                                               ticks: {
-                                                                       bounds: 'labels'
                                                                }
                                                        }],
                                                        yAxes: [{
@@ -1026,8 +1012,8 @@ describe('Time scale tests', function() {
 
        describe('when time.min and/or time.max are defined', function() {
                ['auto', 'data', 'labels'].forEach(function(source) {
-                       ['data', 'labels'].forEach(function(bounds) {
-                               describe('and source is "' + source + '" and bounds "' + bounds + '"', function() {
+                       ['data', 'ticks'].forEach(function(bounds) {
+                               describe('and ticks.source is "' + source + '" and bounds "' + bounds + '"', function() {
                                        beforeEach(function() {
                                                this.chart = window.acquireChart({
                                                        type: 'line',
@@ -1040,13 +1026,13 @@ describe('Time scale tests', function() {
                                                                        xAxes: [{
                                                                                id: 'x',
                                                                                type: 'time',
+                                                                               bounds: bounds,
                                                                                time: {
                                                                                        parser: 'MM/DD HH:mm',
                                                                                        unit: 'day'
                                                                                },
                                                                                ticks: {
-                                                                                       source: source,
-                                                                                       bounds: bounds
+                                                                                       source: source
                                                                                }
                                                                        }],
                                                                        yAxes: [{