Skip to content

Commit d91e017

Browse files
archmojarchmoj
authored
Merge pull request #4661 from plotly/rangebreaks-handle-weekday-str
Handle weekday strings in rangebreaks
2 parents b312392 + 9a0416a commit d91e017

File tree

3 files changed

+181
-8
lines changed

3 files changed

+181
-8
lines changed

‎src/plots/cartesian/axis_defaults.js‎

Lines changed: 83 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
'use strict';
1010

11+
var isNumeric = require('fast-isnumeric');
12+
1113
var Registry = require('../../registry');
1214
var Lib = require('../../lib');
1315

@@ -21,6 +23,9 @@ var handleCategoryOrderDefaults = require('./category_order_defaults');
2123
var handleLineGridDefaults = require('./line_grid_defaults');
2224
var setConvert = require('./set_convert');
2325

26+
var DAY_OF_WEEK = require('./constants').WEEKDAY_PATTERN;
27+
var HOUR = require('./constants').HOUR_PATTERN;
28+
2429
/**
2530
* options: object containing:
2631
*
@@ -155,10 +160,67 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
155160

156161
if(enabled) {
157162
var bnds = coerce('bounds');
158-
159163
if(bnds && bnds.length >= 2) {
160-
if(bnds.length > 2) {
161-
itemOut.bounds = itemOut.bounds.slice(0, 2);
164+
var dfltPattern = '';
165+
var i, q;
166+
if(bnds.length === 2) {
167+
for(i = 0; i < 2; i++) {
168+
q = indexOfDay(bnds[i]);
169+
if(q) {
170+
dfltPattern = DAY_OF_WEEK;
171+
break;
172+
}
173+
}
174+
}
175+
var pattern = coerce('pattern', dfltPattern);
176+
if(pattern === DAY_OF_WEEK) {
177+
for(i = 0; i < 2; i++) {
178+
q = indexOfDay(bnds[i]);
179+
if(q) {
180+
// convert to integers i.e 'Sunday' --> 0
181+
itemOut.bounds[i] = bnds[i] = q - 1;
182+
}
183+
}
184+
}
185+
if(pattern) {
186+
// ensure types and ranges
187+
for(i = 0; i < 2; i++) {
188+
q = bnds[i];
189+
switch(pattern) {
190+
case DAY_OF_WEEK :
191+
if(!isNumeric(q)) {
192+
itemOut.enabled = false;
193+
return;
194+
}
195+
q = +q;
196+
197+
if(
198+
q !== Math.floor(q) || // don't accept fractional days for mow
199+
q < 0 || q >= 7
200+
) {
201+
itemOut.enabled = false;
202+
return;
203+
}
204+
// use number
205+
itemOut.bounds[i] = bnds[i] = q;
206+
break;
207+
208+
case HOUR :
209+
if(!isNumeric(q)) {
210+
itemOut.enabled = false;
211+
return;
212+
}
213+
q = +q;
214+
215+
if(q < 0 || q > 24) { // accept 24
216+
itemOut.enabled = false;
217+
return;
218+
}
219+
// use number
220+
itemOut.bounds[i] = bnds[i] = q;
221+
break;
222+
}
223+
}
162224
}
163225

164226
if(containerOut.autorange === false) {
@@ -175,8 +237,6 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
175237
return;
176238
}
177239
}
178-
179-
coerce('pattern');
180240
} else {
181241
var values = coerce('values');
182242

@@ -189,3 +249,21 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
189249
}
190250
}
191251
}
252+
253+
// these numbers are one more than what bounds would be mapped to
254+
var dayStrToNum = {
255+
sun: 1,
256+
mon: 2,
257+
tue: 3,
258+
wed: 4,
259+
thu: 5,
260+
fri: 6,
261+
sat: 7
262+
};
263+
264+
function indexOfDay(v) {
265+
if(typeof v !== 'string') return;
266+
return dayStrToNum[
267+
v.substr(0, 3).toLowerCase()
268+
];
269+
}

‎src/plots/cartesian/layout_attributes.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,16 +280,18 @@ module.exports = {
280280
pattern: {
281281
valType: 'enumerated',
282282
values: [DAY_OF_WEEK, HOUR, ''],
283-
dflt: '',
284283
role: 'info',
285284
editType: 'calc',
286285
description: [
287286
'Determines a pattern on the time line that generates breaks.',
288-
'If *' + DAY_OF_WEEK + '* - Sunday-based weekday as a decimal number [0, 6].',
287+
'If *' + DAY_OF_WEEK + '* - days of the week in English e.g. \'Sunday\' or `\sun\`',
288+
'(matching is case-insensitive and considers only the first three characters),',
289+
'as well as Sunday-based integers between 0 and 6.',
289290
'If *' + HOUR + '* - hour (24-hour clock) as decimal numbers between 0 and 24.',
290291
'for more info.',
291292
'Examples:',
292-
'- { pattern: \'' + DAY_OF_WEEK + '\', bounds: [6, 0] }',
293+
'- { pattern: \'' + DAY_OF_WEEK + '\', bounds: [6, 1] }',
294+
' or simply { bounds: [\'sat\', \'mon\'] }',
293295
' breaks from Saturday to Monday (i.e. skips the weekends).',
294296
'- { pattern: \'' + HOUR + '\', bounds: [17, 8] }',
295297
' breaks from 5pm to 8am (i.e. skips non-work hours).'

‎test/jasmine/tests/axes_test.js‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1135,6 +1135,99 @@ describe('Test axes', function() {
11351135
expect(layoutOut.xaxis2.rangebreaks[0].pattern).toBe('day of week', 'coerced');
11361136
expect(layoutOut.xaxis3.rangebreaks[0].pattern).toBe(undefined, 'not coerce, using *values*');
11371137
});
1138+
1139+
it('should auto default rangebreaks.pattern to *day of week* when *bounds* include a weekday string and convert bounds to integer days', function() {
1140+
layoutIn = {
1141+
xaxis: {type: 'date', rangebreaks: [
1142+
{bounds: ['Saturday', 'Monday']}
1143+
]},
1144+
xaxis2: {type: 'date', rangebreaks: [
1145+
{bounds: ['sun', 'thu']},
1146+
{bounds: ['mon', 'fri']},
1147+
{bounds: ['tue', 'sat']},
1148+
{bounds: ['wed', '-1']}
1149+
]}
1150+
};
1151+
layoutOut._subplots.xaxis.push('x2');
1152+
supplyLayoutDefaults(layoutIn, layoutOut, fullData);
1153+
1154+
expect(layoutOut.xaxis.rangebreaks[0].pattern).toBe('day of week', 'complete Capital');
1155+
expect(layoutOut.xaxis2.rangebreaks[0].pattern).toBe('day of week', '3-letter case');
1156+
expect(layoutOut.xaxis2.rangebreaks[0].bounds[0]).toBe(0, 'convert sun');
1157+
expect(layoutOut.xaxis2.rangebreaks[1].bounds[0]).toBe(1, 'convert mon');
1158+
expect(layoutOut.xaxis2.rangebreaks[2].bounds[0]).toBe(2, 'convert tue');
1159+
expect(layoutOut.xaxis2.rangebreaks[3].bounds[0]).toBe(3, 'convert wed');
1160+
expect(layoutOut.xaxis2.rangebreaks[0].bounds[1]).toBe(4, 'convert thu');
1161+
expect(layoutOut.xaxis2.rangebreaks[1].bounds[1]).toBe(5, 'convert fri');
1162+
expect(layoutOut.xaxis2.rangebreaks[2].bounds[1]).toBe(6, 'convert sat');
1163+
expect(layoutOut.xaxis2.rangebreaks[3].bounds[1]).toBe('-1', 'string');
1164+
});
1165+
1166+
it('should validate inputs in respect to *day of week* pattern', function() {
1167+
layoutIn = {
1168+
xaxis: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: ['6', '0'] }]},
1169+
xaxis2: {type: 'date', rangebreaks: [{bounds: ['Sunday'] }]},
1170+
xaxis3: {type: 'date', rangebreaks: [{bounds: ['sun', 'mon', 'tue'] }]},
1171+
xaxis4: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '-1'] }]},
1172+
xaxis5: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '-.25'] }]},
1173+
xaxis6: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '7'] }]},
1174+
xaxis7: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '6.75'] }]},
1175+
xaxis8: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, ''] }]},
1176+
xaxis9: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, null] }]},
1177+
xaxis10: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, false] }]},
1178+
xaxis11: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, true] }]}
1179+
};
1180+
layoutOut._subplots.xaxis.push('x2', 'x3', 'x4', 'x5', 'x6', 'x7', 'x8', 'x9', 'x10', 'x11');
1181+
supplyLayoutDefaults(layoutIn, layoutOut, fullData);
1182+
1183+
expect(layoutOut.xaxis.rangebreaks[0].enabled).toBe(true, 'valid');
1184+
expect(layoutOut.xaxis.rangebreaks[0].bounds[0]).toBe(6, 'cast float to int');
1185+
expect(layoutOut.xaxis.rangebreaks[0].bounds[1]).toBe(0, 'cast string to int');
1186+
expect(layoutOut.xaxis2.rangebreaks[0].enabled).toBe(false, 'reject bounds.length < 2');
1187+
expect(layoutOut.xaxis3.rangebreaks[0].enabled).toBe(true, 'do not reject bounds.length > 2');
1188+
expect(layoutOut.xaxis3.rangebreaks[0].bounds.length).toBe(2, 'pick first two');
1189+
expect(layoutOut.xaxis4.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
1190+
expect(layoutOut.xaxis5.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
1191+
expect(layoutOut.xaxis6.rangebreaks[0].enabled).toBe(false, 'reject bound >= 7');
1192+
expect(layoutOut.xaxis7.rangebreaks[0].enabled).toBe(false, 'reject bound < 7 - not supported yet');
1193+
expect(layoutOut.xaxis8.rangebreaks[0].enabled).toBe(false, 'reject blank string');
1194+
expect(layoutOut.xaxis9.rangebreaks[0].enabled).toBe(false, 'reject null');
1195+
expect(layoutOut.xaxis10.rangebreaks[0].enabled).toBe(false, 'reject false');
1196+
expect(layoutOut.xaxis11.rangebreaks[0].enabled).toBe(false, 'reject true');
1197+
});
1198+
1199+
it('should validate inputs in respect to *hour* pattern', function() {
1200+
layoutIn = {
1201+
xaxis: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: ['24', '1e-3'] }]},
1202+
xaxis2: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1] }]},
1203+
xaxis3: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, 2, 3] }]},
1204+
xaxis4: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '-1'] }]},
1205+
xaxis5: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '-.001'] }]},
1206+
xaxis6: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '24.001'] }]},
1207+
xaxis7: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '23.999'] }]},
1208+
xaxis8: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, ''] }]},
1209+
xaxis9: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, null] }]},
1210+
xaxis10: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, false] }]},
1211+
xaxis11: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, true] }]}
1212+
};
1213+
layoutOut._subplots.xaxis.push('x2', 'x3', 'x4', 'x5', 'x6', 'x7', 'x8', 'x9', 'x10', 'x11');
1214+
supplyLayoutDefaults(layoutIn, layoutOut, fullData);
1215+
1216+
expect(layoutOut.xaxis.rangebreaks[0].enabled).toBe(true, 'valid');
1217+
expect(layoutOut.xaxis.rangebreaks[0].bounds[0]).toBe(24, 'accept 24');
1218+
expect(layoutOut.xaxis.rangebreaks[0].bounds[1]).toBe(0.001, 'cast string to float');
1219+
expect(layoutOut.xaxis2.rangebreaks[0].enabled).toBe(false, 'reject bounds.length < 2');
1220+
expect(layoutOut.xaxis3.rangebreaks[0].enabled).toBe(true, 'do not reject bounds.length > 2');
1221+
expect(layoutOut.xaxis3.rangebreaks[0].bounds.length).toBe(2, 'pick first two');
1222+
expect(layoutOut.xaxis4.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
1223+
expect(layoutOut.xaxis5.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
1224+
expect(layoutOut.xaxis6.rangebreaks[0].enabled).toBe(false, 'reject bound > 24');
1225+
expect(layoutOut.xaxis7.rangebreaks[0].enabled).toBe(true, 'do not reject bound <= 24');
1226+
expect(layoutOut.xaxis8.rangebreaks[0].enabled).toBe(false, 'reject blank string');
1227+
expect(layoutOut.xaxis9.rangebreaks[0].enabled).toBe(false, 'reject null');
1228+
expect(layoutOut.xaxis10.rangebreaks[0].enabled).toBe(false, 'reject false');
1229+
expect(layoutOut.xaxis11.rangebreaks[0].enabled).toBe(false, 'reject true');
1230+
});
11381231
});
11391232

11401233
describe('constraints relayout', function() {

0 commit comments

Comments
 (0)