Handle day of week str - add auto dflt for pattern

Author: archmoj

src/plots/cartesian/axis_defaults.js

@@ -21,6 +21,8 @@ var handleCategoryOrderDefaults = require('./category_order_defaults');
 var handleLineGridDefaults = require('./line_grid_defaults');
 var setConvert = require('./set_convert');
 
+var DAY_OF_WEEK = require('./constants').WEEKDAY_PATTERN;
+
 /**
  * options: object containing:
  *
@@ -161,6 +163,27 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
                 itemOut.bounds = itemOut.bounds.slice(0, 2);
             }
 
+            var dfltPattern = '';
+            var i, q;
+            for(i = 0; i < bnds.length; i++) {
+                q = indexOfDay(bnds[i]);
+                if(q !== -1) {
+                    dfltPattern = DAY_OF_WEEK;
+                    break;
+                }
+            }
+            var pattern = coerce('pattern', dfltPattern);
+
+            if(pattern === DAY_OF_WEEK) {
+                for(i = 0; i < bnds.length; i++) {
+                    q = indexOfDay(bnds[i]);
+                    if(q !== -1) {
+                        // convert to integers i.e 'Monday' --> 1
+                        itemOut.bounds[i] = bnds[i] = q;
+                    }
+                }
+            }
+
             if(containerOut.autorange === false) {
                 var rng = containerOut.range;
 
@@ -175,8 +198,6 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
                     return;
                 }
             }
-
-            coerce('pattern');
         } else {
             var values = coerce('values');
 
@@ -189,3 +210,18 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
         }
     }
 }
+
+var weekSTR = [
+    'sun',
+    'mon',
+    'tue',
+    'wed',
+    'thu',
+    'fri',
+    'sat'
+];
+
+function indexOfDay(v) {
+    var str = String(v).substr(0, 3).toLowerCase();
+    return weekSTR.indexOf(str);
+}

src/plots/cartesian/layout_attributes.js

@@ -280,16 +280,17 @@ module.exports = {
         pattern: {
             valType: 'enumerated',
             values: [DAY_OF_WEEK, HOUR, ''],
-            dflt: '',
             role: 'info',
             editType: 'calc',
             description: [
                 'Determines a pattern on the time line that generates breaks.',
-                'If *' + DAY_OF_WEEK + '* - Sunday-based weekday as a decimal number [0, 6].',
+                'If *' + DAY_OF_WEEK + '* - days of the week in English e.g. \'Sunday\' or `\sun\`',
+                'as well as Sunday-based integers between 0 and 6.',
                 'If *' + HOUR + '* - hour (24-hour clock) as decimal numbers between 0 and 24.',
                 'for more info.',
                 'Examples:',
-                '- { pattern: \'' + DAY_OF_WEEK + '\', bounds: [6, 0] }',
+                '- { pattern: \'' + DAY_OF_WEEK + '\', bounds: [6, 1] }',
+                ' or simply { bounds: [\'sat\', \'mon\'] }',
                 '  breaks from Saturday to Monday (i.e. skips the weekends).',
                 '- { pattern: \'' + HOUR + '\', bounds: [17, 8] }',
                 '  breaks from 5pm to 8am (i.e. skips non-work hours).'