Skip to content

Commit db38ce9

Browse files
committed
update description to mention integer hours - use constants for flags
1 parent 8cc498e commit db38ce9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/plots/cartesian/layout_attributes.js

+7-5
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ var FORMAT_LINK = require('../../constants/docs').FORMAT_LINK;
1818
var DATE_FORMAT_LINK = require('../../constants/docs').DATE_FORMAT_LINK;
1919
var ONEDAY = require('../../constants/numerical').ONEDAY;
2020
var constants = require('./constants');
21+
var HOUR = constants.HOUR_PATTERN;
22+
var DAY_OF_WEEK = constants.WEEKDAY_PATTERN;
2123

2224
module.exports = {
2325
visible: {
@@ -278,19 +280,19 @@ module.exports = {
278280

279281
pattern: {
280282
valType: 'enumerated',
281-
values: ['day of week', 'hour', ''],
283+
values: [DAY_OF_WEEK, HOUR, ''],
282284
dflt: '',
283285
role: 'info',
284286
editType: 'calc',
285287
description: [
286288
'Determines a pattern on the time line that generates breaks.',
287-
'If *day of week* - Sunday-based weekday as a decimal number [0, 6].',
288-
'If *hour* - hour (24-hour clock) as a decimal number [0, 23].',
289+
'If *' + DAY_OF_WEEK + '* - Sunday-based weekday as a decimal number [0, 6].',
290+
'If *' + HOUR + '* - hour (24-hour clock) as integer numbers [0, 24].',
289291
'for more info.',
290292
'Examples:',
291-
'- { pattern: \'day of week\', bounds: [6, 0] }',
293+
'- { pattern: \'' + DAY_OF_WEEK + '\', bounds: [6, 0] }',
292294
' breaks from Saturday to Monday (i.e. skips the weekends).',
293-
'- { pattern: \'hour\', bounds: [17, 8], operation: \'()\' }', // TODO: simplify after revise defaults
295+
'- { pattern: \'' + HOUR + '\', bounds: [17, 8], operation: \'()\' }', // TODO: simplify after revise defaults
294296
' breaks from 5pm to 8am (i.e. skips non-work hours).'
295297
].join(' ')
296298
},

0 commit comments

Comments
 (0)