Skip to content

Commit 6cb4e71

Browse files
alexcjohnsonalexcjohnson
committed
test bin_label_vals
1 parent ad0e08f commit 6cb4e71

File tree

1 file changed

+206
-0
lines changed

1 file changed

+206
-0
lines changed

‎test/jasmine/tests/histogram_test.js

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
var Plotly = require('@lib/index');
22
var Plots = require('@src/plots/plots');
33
var Lib = require('@src/lib');
4+
var setConvert = require('@src/plots/cartesian/set_convert');
45

56
var supplyDefaults = require('@src/traces/histogram/defaults');
67
var calc = require('@src/traces/histogram/calc');
8+
var getBinSpanLabelRound = require('@src/traces/histogram/bin_label_vals');
79

810
var createGraphDiv = require('../assets/create_graph_div');
911
var destroyGraphDiv = require('../assets/destroy_graph_div');
@@ -664,3 +666,207 @@ describe('Test histogram', function() {
664666
});
665667
});
666668
});
669+
670+
describe('getBinSpanLabelRound', function() {
671+
function _test(leftGap, rightGap, edges, calendar, expected) {
672+
var ax = {type: 'not date'};
673+
// only date axes have any different treatment here. We could explicitly
674+
// test category
675+
if(calendar) {
676+
ax = {type: 'date', calendar: 'gregorian', range: [0, 1e7]};
677+
setConvert(ax);
678+
}
679+
680+
var roundFn = getBinSpanLabelRound(leftGap, rightGap, edges, ax, calendar);
681+
682+
var j = 0;
683+
var PREC = calendar ? 1 : 6;
684+
edges.forEach(function(edge, i) {
685+
if(i) {
686+
expect(roundFn(edge, true)).toBeCloseTo(expected[j], PREC, 'right ' + i);
687+
j++;
688+
}
689+
if(i < edges.length - 1) {
690+
expect(roundFn(edge)).toBeCloseTo(expected[j], PREC, 'left ' + i);
691+
j++;
692+
}
693+
});
694+
}
695+
696+
it('works when the bin edges are round numbers and data are "continuous"', function() {
697+
_test(0.05, 0.3, [0, 2, 4, 6], false, [0, 1.9, 2, 3.9, 4, 5.9]);
698+
_test(0, 0.1, [0, 1, 2], false, [0, 0.9, 1, 1.9]);
699+
_test(0, 0.001, [0, 1, 2], false, [0, 0.999, 1, 1.999]);
700+
_test(0.1, 0.1, [115, 125, 135], false, [115, 124.9, 125, 134.9]);
701+
_test(0.1, 0.01, [115, 125, 135], false, [115, 124.99, 125, 134.99]);
702+
_test(10, 100, [5000, 6000, 7000], false, [5000, 5900, 6000, 6900]);
703+
704+
// too small of a right gap: stop disambiguating data at the edge
705+
_test(0, 0.0009, [0, 1, 2], false, [0, 1, 1, 2]);
706+
_test(0.1, 0.009, [115, 125, 135], false, [115, 125, 125, 135]);
707+
});
708+
709+
it('works when the bins are shifted to be less round than the data', function() {
710+
// integer or category data look like this - though categories don't even
711+
// get here normally, unless you explicitly ask to bin multiple categories
712+
// together, because uniqueValsPerBin will be true
713+
_test(0.5, 0.5, [-0.5, 4.5, 9.5], false, [0, 4, 5, 9]);
714+
715+
_test(0.013, 0.087, [-0.013, 0.987, 1.987], false, [0, 0.9, 1, 1.9]);
716+
_test(500, 500, [4500, 9500, 14500], false, [5000, 9000, 10000, 14000]);
717+
});
718+
719+
var jan17 = Date.UTC(2017, 0, 1);
720+
var feb17 = Date.UTC(2017, 1, 1);
721+
var mar17 = Date.UTC(2017, 2, 1);
722+
var jan18 = Date.UTC(2018, 0, 1);
723+
var jan19 = Date.UTC(2019, 0, 1);
724+
var j2116 = Date.UTC(2116, 0, 1);
725+
var j2117 = Date.UTC(2117, 0, 1);
726+
var j2216 = Date.UTC(2216, 0, 1);
727+
var j2217 = Date.UTC(2217, 0, 1);
728+
var sec = 1000;
729+
var min = 60 * sec;
730+
var hr = 60 * min;
731+
var day = 24 * hr;
732+
733+
it('rounds dates to full fields (if larger than seconds) - round bin edges case', function() {
734+
// sub-second & 1-second resolution
735+
_test(0, 0.1, [jan17, jan17 + 1, jan17 + 2], 'gregorian',
736+
[jan17, jan17 + 0.9, jan17 + 1, jan17 + 1.9]);
737+
_test(1, 3, [jan17, jan17 + 20, jan17 + 40], 'gregorian',
738+
[jan17, jan17 + 19, jan17 + 20, jan17 + 39]);
739+
_test(5, 35, [jan17, jan17 + 1000, jan17 + 2000], 'gregorian',
740+
[jan17, jan17 + 990, jan17 + 1000, jan17 + 1990]);
741+
_test(0, 100, [jan17, jan17 + 20000, jan17 + 40000], 'gregorian',
742+
[jan17, jan17 + 19900, jan17 + 20000, jan17 + 39900]);
743+
_test(100, 2000, [jan17, jan17 + 10000, jan17 + 20000], 'gregorian',
744+
[jan17, jan17 + 9000, jan17 + 10000, jan17 + 19000]);
745+
746+
// > second, only go to the next full field
747+
// 30 sec gap - still show seconds
748+
_test(0, 30 * sec, [jan17, jan17 + 5 * min, jan17 + 10 * min], 'gregorian',
749+
[jan17, jan17 + 5 * min - sec, jan17 + 5 * min, jan17 + 10 * min - sec]);
750+
// 1-minute gap round to minutes
751+
_test(10 * sec, min, [jan17, jan17 + 5 * min, jan17 + 10 * min], 'gregorian',
752+
[jan17, jan17 + 4 * min, jan17 + 5 * min, jan17 + 9 * min]);
753+
// 30-minute gap - still show minutes
754+
_test(0, 30 * min, [jan17, jan17 + day, jan17 + 2 * day], 'gregorian',
755+
[jan17, jan17 + day - min, jan17 + day, jan17 + 2 * day - min]);
756+
// 1-hour gap - round to hours
757+
_test(0, hr, [jan17, jan17 + day, jan17 + 2 * day], 'gregorian',
758+
[jan17, jan17 + day - hr, jan17 + day, jan17 + 2 * day - hr]);
759+
// 12-hour gap - still hours
760+
_test(0, 12 * hr, [jan17, feb17, mar17], 'gregorian',
761+
[jan17, feb17 - hr, feb17, mar17 - hr]);
762+
// 1-day gap - round to days
763+
_test(0, day, [jan17, feb17, mar17], 'gregorian',
764+
[jan17, feb17 - day, feb17, mar17 - day]);
765+
// 15-day gap - still days
766+
_test(0, 15 * day, [jan17, jan18, jan19], 'gregorian',
767+
[jan17, jan18 - day, jan18, jan19 - day]);
768+
// 28-day gap STILL gets days - in principle this might happen with data
769+
// that's actually monthly, if the bins edges fall on different months
770+
// (ie not full years) but that's a very weird edge case so I'll ignore it!
771+
_test(0, 28 * day, [jan17, jan18, jan19], 'gregorian',
772+
[jan17, jan18 - day, jan18, jan19 - day]);
773+
// 31-day gap - months
774+
_test(0, 31 * day, [jan17, jan18, jan19], 'gregorian',
775+
[jan17, Date.UTC(2017, 11, 1), jan18, Date.UTC(2018, 11, 1)]);
776+
// 365-day gap - years have enough buffer to handle leap vs nonleap years
777+
_test(0, 365 * day, [jan17, j2117, j2217], 'gregorian',
778+
[jan17, j2116, j2117, j2216]);
779+
// no bigger rounding than years
780+
_test(0, 40 * 365 * day, [jan17, j2117, j2217], 'gregorian',
781+
[jan17, j2116, j2117, j2216]);
782+
});
783+
784+
it('rounds dates to full fields (if larger than seconds) - round data case', function() {
785+
// sub-second & 1-second resolution
786+
_test(0.05, 0.05, [jan17 - 0.05, jan17 + 0.95, jan17 + 1.95], 'gregorian',
787+
[jan17, jan17 + 0.9, jan17 + 1, jan17 + 1.9]);
788+
_test(0.5, 3.5, [jan17 - 0.5, jan17 + 19.5, jan17 + 39.5], 'gregorian',
789+
[jan17, jan17 + 19, jan17 + 20, jan17 + 39]);
790+
_test(5, 35, [jan17 - 5, jan17 + 995, jan17 + 1995], 'gregorian',
791+
[jan17, jan17 + 990, jan17 + 1000, jan17 + 1990]);
792+
_test(50, 50, [jan17 - 50, jan17 + 19950, jan17 + 39950], 'gregorian',
793+
[jan17, jan17 + 19900, jan17 + 20000, jan17 + 39900]);
794+
_test(500, 2500, [jan17 - 500, jan17 + 9500, jan17 + 19500], 'gregorian',
795+
[jan17, jan17 + 9000, jan17 + 10000, jan17 + 19000]);
796+
797+
// > second, only go to the next full field
798+
// 30 sec gap - still show seconds
799+
_test(15 * sec, 15 * sec, [jan17 - 15 * sec, jan17 + 5 * min - 15 * sec, jan17 + 10 * min - 15 * sec], 'gregorian',
800+
[jan17 - 15 * sec, jan17 + 5 * min - 16 * sec, jan17 + 5 * min - 15 * sec, jan17 + 10 * min - 16 * sec]);
801+
// 1-minute gap round to minutes
802+
_test(30 * sec, 30 * sec, [jan17 - 30 * sec, jan17 + 5 * min - 30 * sec, jan17 + 10 * min - 30 * sec], 'gregorian',
803+
[jan17, jan17 + 4 * min, jan17 + 5 * min, jan17 + 9 * min]);
804+
// 30-minute gap - still show minutes
805+
_test(15 * min, 15 * min, [jan17 - 15 * min, jan17 + day - 15 * min, jan17 + 2 * day - 15 * min], 'gregorian',
806+
[jan17 - 15 * min, jan17 + day - 16 * min, jan17 + day - 15 * min, jan17 + 2 * day - 16 * min]);
807+
// 1-hour gap - round to hours
808+
_test(30 * min, 30 * min, [jan17 - 30 * min, jan17 + day - 30 * min, jan17 + 2 * day - 30 * min], 'gregorian',
809+
[jan17, jan17 + day - hr, jan17 + day, jan17 + 2 * day - hr]);
810+
// 12-hour gap - still hours
811+
_test(6 * hr, 6 * hr, [jan17 - 6 * hr, feb17 - 6 * hr, mar17 - 6 * hr], 'gregorian',
812+
[jan17 - 6 * hr, feb17 - 7 * hr, feb17 - 6 * hr, mar17 - 7 * hr]);
813+
// 1-day gap - round to days
814+
_test(12 * hr, 12 * hr, [jan17 - 12 * hr, feb17 - 12 * hr, mar17 - 12 * hr], 'gregorian',
815+
[jan17, feb17 - day, feb17, mar17 - day]);
816+
// 15-day gap - still days
817+
_test(7 * day, 8 * day, [jan17 - 7 * day, jan18 - 7 * day, jan19 - 7 * day], 'gregorian',
818+
[jan17 - 7 * day, jan18 - 8 * day, jan18 - 7 * day, jan19 - 8 * day]);
819+
// 28-day gap STILL gets days - in principle this might happen with data
820+
// that's actually monthly, if the bins edges fall on different months
821+
// (ie not full years) but that's a very weird edge case so I'll ignore it!
822+
_test(14 * day, 14 * day, [jan17 - 14 * day, jan18 - 14 * day, jan19 - 14 * day], 'gregorian',
823+
[jan17 - 14 * day, jan18 - 15 * day, jan18 - 14 * day, jan19 - 15 * day]);
824+
// 31-day gap - months
825+
_test(15 * day, 16 * day, [jan17 - 15 * day, jan18 - 15 * day, jan19 - 15 * day], 'gregorian',
826+
[jan17, Date.UTC(2017, 11, 1), jan18, Date.UTC(2018, 11, 1)]);
827+
// 365-day gap - years have enough buffer to handle leap vs nonleap years
828+
_test(182 * day, 183 * day, [jan17 - 182 * day, j2117 - 182 * day, j2217 - 182 * day], 'gregorian',
829+
[jan17, j2116, j2117, j2216]);
830+
// no bigger rounding than years
831+
_test(20 * 365 * day, 20 * 365 * day, [jan17, j2117, j2217], 'gregorian',
832+
[jan17, j2116, j2117, j2216]);
833+
});
834+
835+
it('rounds (mostly) correctly when using world calendars', function() {
836+
var cn = 'chinese';
837+
var cn8 = Lib.dateTime2ms('1995-08-01', cn);
838+
var cn8i = Lib.dateTime2ms('1995-08i-01', cn);
839+
var cn9 = Lib.dateTime2ms('1995-09-01', cn);
840+
841+
var cn1_00 = Lib.dateTime2ms('2000-01-01', cn);
842+
var cn1_01 = Lib.dateTime2ms('2001-01-01', cn);
843+
var cn1_02 = Lib.dateTime2ms('2002-01-01', cn);
844+
var cn1_10 = Lib.dateTime2ms('2010-01-01', cn);
845+
var cn1_20 = Lib.dateTime2ms('2020-01-01', cn);
846+
847+
_test(100, 2000, [cn8i, cn8i + 10000, cn8i + 20000], cn,
848+
[cn8i, cn8i + 9000, cn8i + 10000, cn8i + 19000]);
849+
_test(500, 2500, [cn8i - 500, cn8i + 9500, cn8i + 19500], cn,
850+
[cn8i, cn8i + 9000, cn8i + 10000, cn8i + 19000]);
851+
852+
_test(0, day, [cn8, cn8i, cn9], cn,
853+
[cn8, cn8i - day, cn8i, cn9 - day]);
854+
_test(12 * hr, 12 * hr, [cn8 - 12 * hr, cn8i - 12 * hr, cn9 - 12 * hr], cn,
855+
[cn8, cn8i - day, cn8i, cn9 - day]);
856+
857+
_test(0, 28 * day, [cn1_00, cn1_01, cn1_02], cn,
858+
[cn1_00, Lib.dateTime2ms('2000-12-01', cn), cn1_01, Lib.dateTime2ms('2001-12-01', cn)]);
859+
_test(14 * day, 14 * day, [cn1_00 - 14 * day, cn1_01 - 14 * day, cn1_02 - 14 * day], cn,
860+
[cn1_00, Lib.dateTime2ms('2000-12-01', cn), cn1_01, Lib.dateTime2ms('2001-12-01', cn)]);
861+
862+
_test(0, 353 * day, [cn1_00, cn1_10, cn1_20], cn,
863+
[cn1_00, Lib.dateTime2ms('2009-01-01', cn), cn1_10, Lib.dateTime2ms('2019-01-01', cn)]);
864+
// occasionally we give extra precision for world dates (month when it should be year
865+
// or day when it should be month). That's better than doing the opposite... not going
866+
// to fix now, too many edge cases, better not to complicate the logic for them all.
867+
_test(176 * day, 177 * day, [cn1_00 - 176 * day, cn1_10 - 176 * day, cn1_20 - 176 * day], cn, [
868+
Lib.dateTime2ms('1999-08-01', cn), Lib.dateTime2ms('2009-07-01', cn),
869+
Lib.dateTime2ms('2009-08-01', cn), Lib.dateTime2ms('2019-07-01', cn)
870+
]);
871+
});
872+
});

0 commit comments

Comments
 (0)