date interval milliseconds constants

Author: alexcjohnson

src/constants/numerical.js

@@ -23,5 +23,18 @@ module.exports = {
      * to avoid glitches: Make sure that even when you multiply it by the
      * number of pixels on a giant screen it still works
      */
-    FP_SAFE: Number.MAX_VALUE / 10000
+    FP_SAFE: Number.MAX_VALUE / 10000,
+
+    /*
+     * conversion of date units to milliseconds
+     * year and month constants are marked "AVG"
+     * to remind us that not all years and months
+     * have the same length
+     */
+    ONEAVGYEAR: 31557600000, // 365.25 days
+    ONEAVGMONTH: 2629800000, // 1/12 of ONEAVGYEAR
+    ONEDAY: 86400000,
+    ONEHOUR: 3600000,
+    ONEMIN: 60000,
+    ONESEC: 1000
 };

src/lib/dates.js

@@ -11,9 +11,16 @@
 
 var d3 = require('d3');
 var isNumeric = require('fast-isnumeric');
-var BADNUM = require('../constants/numerical').BADNUM;
+
 var logError = require('./loggers').error;
 
+var constants = require('../constants/numerical');
+var BADNUM = constants.BADNUM;
+var ONEDAY = constants.ONEDAY;
+var ONEHOUR = constants.ONEHOUR;
+var ONEMIN = constants.ONEMIN;
+var ONESEC = constants.ONESEC;
+
 // is an object a javascript date?
 exports.isJSDate = function(v) {
     return typeof v === 'object' && v !== null && typeof v.getTime === 'function';
@@ -140,14 +147,14 @@ exports.dateTime2ms = function(s) {
                     // minute - must be 2 digits
                     m = Number(p[1]);
                     if(p[1].length !== 2 || !(m >= 0 && m <= 59)) return BADNUM;
-                    d += 60000 * m;
+                    d += ONEMIN * m;
                     if(p.length === 2) return d;
 
                     // second (and milliseconds) - must have 2-digit seconds
                     if(p[2].split('.')[0].length !== 2) return BADNUM;
                     s = Number(p[2]);
                     if(!(s >= 0 && s < 60)) return BADNUM;
-                    return d + s * 1000;
+                    return d + s * ONESEC;
                 }
             }
         }
@@ -176,6 +183,9 @@ function lpad(val, digits) {
  * Optional range r is the data range that applies, also in ms.
  * If rng is big, the later parts of time will be omitted
  */
+var NINETYDAYS = 90 * ONEDAY;
+var THREEHOURS = 3 * ONEHOUR;
+var FIVEMIN = 5 * ONEMIN;
 exports.ms2DateTime = function(ms, r) {
     if(typeof ms !== 'number' || !(ms >= MIN_MS && ms <= MAX_MS)) return BADNUM;
 
@@ -184,12 +194,12 @@ exports.ms2DateTime = function(ms, r) {
     var d = new Date(Math.floor(ms)),
         dateStr = d3.time.format('%Y-%m-%d')(d),
         // <90 days: add hours and minutes - never *only* add hours
-        h = (r < 7776000000) ? d.getHours() : 0,
-        m = (r < 7776000000) ? d.getMinutes() : 0,
+        h = (r < NINETYDAYS) ? d.getHours() : 0,
+        m = (r < NINETYDAYS) ? d.getMinutes() : 0,
         // <3 hours: add seconds
-        s = (r < 10800000) ? d.getSeconds() : 0,
+        s = (r < THREEHOURS) ? d.getSeconds() : 0,
         // <5 minutes: add ms (plus one extra digit, this is msec*10)
-        msec10 = (r < 300000) ? Math.round((d.getMilliseconds() + (((ms % 1) + 1) % 1)) * 10) : 0;
+        msec10 = (r < FIVEMIN) ? Math.round((d.getMilliseconds() + (((ms % 1) + 1) % 1)) * 10) : 0;
 
     // include each part that has nonzero data in or after it
     if(h || m || s || msec10) {

src/plots/cartesian/axes.js

@@ -19,7 +19,14 @@ var Titles = require('../../components/titles');
 var Color = require('../../components/color');
 var Drawing = require('../../components/drawing');
 
-var FP_SAFE = require('../../constants/numerical').FP_SAFE;
+var constants = require('../../constants/numerical');
+var FP_SAFE = constants.FP_SAFE;
+var ONEAVGYEAR = constants.ONEAVGYEAR;
+var ONEAVGMONTH = constants.ONEAVGMONTH;
+var ONEDAY = constants.ONEDAY;
+var ONEHOUR = constants.ONEHOUR;
+var ONEMIN = constants.ONEMIN;
+var ONESEC = constants.ONESEC;
 
 
 var axes = module.exports = {};
@@ -727,7 +734,7 @@ function roundDTick(roughDTick, base, roundingSet) {
 // outputs (into ax):
 //   tick0: starting point for ticks (not necessarily on the graph)
 //      usually 0 for numeric (=10^0=1 for log) or jan 1, 2000 for dates
-//   dtick: the actual, nice round tick spacing, somewhat larger than roughDTick
+//   dtick: the actual, nice round tick spacing, usually a little larger than roughDTick
 //      if the ticks are spaced linearly (linear scale, categories,
 //          log with only full powers, date ticks < month),
 //          this will just be a number
@@ -741,37 +748,34 @@ axes.autoTicks = function(ax, roughDTick) {
 
     if(ax.type === 'date') {
         ax.tick0 = '2000-01-01';
+        // the criteria below are all based on the rough spacing we calculate
+        // being > half of the final unit - so precalculate twice the rough val
+        var roughX2 = 2 * roughDTick;
 
-        if(roughDTick > 15778800000) {
-            // years if roughDTick > 6mo
-            roughDTick /= 31557600000;
+        if(roughX2 > ONEAVGYEAR) {
+            roughDTick /= ONEAVGYEAR;
             base = Math.pow(10, Math.floor(Math.log(roughDTick) / Math.LN10));
             ax.dtick = 'M' + (12 * roundDTick(roughDTick, base, roundBase10));
         }
-        else if(roughDTick > 1209600000) {
-            // months if roughDTick > 2wk
-            roughDTick /= 2629800000;
+        else if(roughX2 > ONEAVGMONTH) {
+            roughDTick /= ONEAVGMONTH;
             ax.dtick = 'M' + roundDTick(roughDTick, 1, roundBase24);
         }
-        else if(roughDTick > 43200000) {
-            // days if roughDTick > 12h
-            ax.dtick = roundDTick(roughDTick, 86400000, roundDays);
+        else if(roughX2 > ONEDAY) {
+            ax.dtick = roundDTick(roughDTick, ONEDAY, roundDays);
             // get week ticks on sunday
             // this will also move the base tick off 2000-01-01 if dtick is
             // 2 or 3 days... but that's a weird enough case that we'll ignore it.
             ax.tick0 = '2000-01-02';
         }
-        else if(roughDTick > 1800000) {
-            // hours if roughDTick > 30m
-            ax.dtick = roundDTick(roughDTick, 3600000, roundBase24);
+        else if(roughX2 > ONEHOUR) {
+            ax.dtick = roundDTick(roughDTick, ONEHOUR, roundBase24);
         }
-        else if(roughDTick > 30000) {
-            // minutes if roughDTick > 30sec
-            ax.dtick = roundDTick(roughDTick, 60000, roundBase60);
+        else if(roughX2 > ONEMIN) {
+            ax.dtick = roundDTick(roughDTick, ONEMIN, roundBase60);
         }
-        else if(roughDTick > 500) {
-            // seconds if roughDTick > 0.5sec
-            ax.dtick = roundDTick(roughDTick, 1000, roundBase60);
+        else if(roughX2 > ONESEC) {
+            ax.dtick = roundDTick(roughDTick, ONESEC, roundBase60);
         }
         else {
             // milliseconds
@@ -826,11 +830,6 @@ axes.autoTicks = function(ax, roughDTick) {
     }
 };
 
-var ONEDAY = 86400000,
-    ONEHOUR = 3600000,
-    ONEMIN = 60000,
-    ONESEC = 1000;
-
 // after dtick is already known, find tickround = precision
 // to display in tick labels
 //   for numeric ticks, integer # digits after . to round to

src/plots/cartesian/tick_value_defaults.js

@@ -11,6 +11,7 @@
 
 var isNumeric = require('fast-isnumeric');
 var Lib = require('../../lib');
+var ONEDAY = require('../../constants/numerical').ONEDAY;
 
 
 module.exports = function handleTickValueDefaults(containerIn, containerOut, coerce, axType) {
@@ -32,7 +33,7 @@ module.exports = function handleTickValueDefaults(containerIn, containerOut, coe
         // dtick is usually a positive number, but there are some
         // special strings available for log or date axes
         // default is 1 day for dates, otherwise 1
-        var dtickDflt = (axType === 'date') ? 86400000 : 1;
+        var dtickDflt = (axType === 'date') ? ONEDAY : 1;
         var dtick = coerce('dtick', dtickDflt);
         if(isNumeric(dtick)) {
             containerOut.dtick = (dtick > 0) ? Number(dtick) : dtickDflt;