[Time Conductor] Conductor pan, zoom, and time of interest

example/generator/bundle.js

@@ -99,7 +99,7 @@ define([
                         "source": "generator",
                         "domains": [
                             {
-                                "key": "time",
+                                "key": "utc",
                                 "name": "Time"
                             },
                             {

example/msl/bundle.js

@@ -59,7 +59,7 @@ define([
                     "domains": [
                         {
                             "name": "Time",
-                            "key": "timestamp",
+                            "key": "utc",
                             "format": "utc"
                         }
                     ]

platform/commonUI/formats/src/UTCTimeFormat.js

@@ -95,6 +95,45 @@ define([
         })[0][0];
     }
 
+    /**
+     * Returns a description of the current range of the time conductor's
+     * bounds.
+     * @param timeRange
+     * @returns {*}
+     */
+    UTCTimeFormat.prototype.timeUnits = function (timeRange) {
+        var momentified = moment.duration(timeRange);
+
+        return [
+            ["Decades", function (r) {
+                return r.years() > 15;
+            }],
+            ["Years", function (r) {
+                return r.years() > 1;
+            }],
+            ["Months", function (r) {
+                return r.years() === 1 || r.months() > 1;
+            }],
+            ["Days", function (r) {
+                return r.months() === 1 || r.days() > 1;
+            }],
+            ["Hours", function (r) {
+                return r.days() === 1 || r.hours() > 1;
+            }],
+            ["Minutes", function (r) {
+                return r.hours() === 1 || r.minutes() > 1;
+            }],
+            ["Seconds", function (r) {
+                return r.minutes() === 1 || r.seconds() > 1;
+            }],
+            ["Milliseconds", function (r) {
+                return true;
+            }]
+        ].filter(function (row) {
+            return row[1](momentified);
+        })[0][0];
+    };
+
     /**
      *
      * @param value

platform/commonUI/formats/src/UTCTimeFormatSpec.js

@@ -58,5 +58,26 @@ define([
             expect(format.format(APRIL, scale)).toBe("April");
             expect(format.format(TWENTY_SIXTEEN, scale)).toBe("2016");
         });
+
+        it("Returns appropriate time units for a given time span", function () {
+            var ONE_DAY = 1000 * 60 * 60 * 24;
+            var FIVE_DAYS = 5 * ONE_DAY;
+            var FIVE_MONTHS = 60 * ONE_DAY;
+
+            var ONE_YEAR = 365 * ONE_DAY;
+            var SEVEN_YEARS = 7 * ONE_YEAR;
+            var TWO_DECADES = 20 * ONE_YEAR;
+
+            //A span of one day should show a zoom label of "Hours"
+            expect(format.timeUnits(ONE_DAY)).toEqual("Hours");
+            //Multiple days should display "Days"
+            expect(format.timeUnits(FIVE_DAYS)).toEqual("Days");
+            expect(format.timeUnits(FIVE_MONTHS)).toEqual("Days");
+            //A span of one year should show a zoom level of "Months".
+            // Multiple years will show "Years"
+            expect(format.timeUnits(ONE_YEAR)).toEqual("Months");
+            expect(format.timeUnits(SEVEN_YEARS)).toEqual("Years");
+            expect(format.timeUnits(TWO_DECADES)).toEqual("Decades");
+        });
     });
 });