highcharts 6.1.4 → 6.2.0

package/js/es-modules/parts/Axis.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -168,7 +168,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {boolean}
          * @default   true
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.alignTicks
          */
 
@@ -219,7 +219,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {Array<*>}
          * @since     4.1.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.breaks
          */
 
@@ -232,7 +232,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @type      {number}
          * @default   0
          * @since     4.1.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.breaks.breakSize
          */
 
@@ -241,7 +241,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     4.1.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.breaks.from
          */
 
@@ -252,7 +252,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @type      {number}
          * @default   0
          * @since     4.1.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.breaks.repeat
          */
 
@@ -261,7 +261,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     4.1.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.breaks.to
          */
 
@@ -296,7 +296,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type       {number}
          * @since      4.0
-         * @product    highcharts highstock
+         * @product    highcharts highstock gantt
          * @apioption  xAxis.ceiling
          */
 
@@ -561,17 +561,37 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @sample {highstock} stock/xaxis/datetimelabelformats/
          *         More information in x axis labels
          *
-         * @product highcharts highstock
+         * @product highcharts highstock gantt
          */
         dateTimeLabelFormats: {
-            millisecond: '%H:%M:%S.%L',
-            second: '%H:%M:%S',
-            minute: '%H:%M',
-            hour: '%H:%M',
-            day: '%e. %b',
-            week: '%e. %b',
-            month: '%b \'%y',
-            year: '%Y'
+            millisecond: {
+                main: '%H:%M:%S.%L',
+                range: false
+            },
+            second: {
+                main: '%H:%M:%S',
+                range: false
+            },
+            minute: {
+                main: '%H:%M',
+                range: false
+            },
+            hour: {
+                main: '%H:%M',
+                range: false
+            },
+            day: {
+                main: '%e. %b'
+            },
+            week: {
+                main: '%e. %b'
+            },
+            month: {
+                main: '%b \'%y'
+            },
+            year: {
+                main: '%Y'
+            }
         },
 
         /**
@@ -622,7 +642,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {Function}
          * @since     4.1.0
-         * @product   highcharts
+         * @product   highcharts gantt
          * @apioption xAxis.events.afterBreaks
          */
 
@@ -657,7 +677,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {Function}
          * @since     4.1.0
-         * @product   highcharts
+         * @product   highcharts gantt
          * @context   Axis
          * @apioption xAxis.events.pointBreak
          */
@@ -666,7 +686,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * An event fired when a point falls inside a break from this axis.
          *
          * @type      {Function}
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @context   Axis
          * @apioption xAxis.events.pointInBreak
          */
@@ -704,7 +724,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     4.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.floor
          */
 
@@ -736,7 +756,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @default   1
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.gridZIndex
          */
 
@@ -802,7 +822,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * @type      {Array<number>}
              * @default   [-45]
              * @since     4.1.0
-             * @product   highcharts highstock
+             * @product   highcharts highstock gantt
              * @apioption xAxis.labels.autoRotation
              */
 
@@ -819,7 +839,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * @type      {number}
              * @default   80
              * @since     4.1.5
-             * @product   highcharts
+             * @product   highcharts gantt
              * @apioption xAxis.labels.autoRotationLimit
              */
 
@@ -829,7 +849,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              *
              * @type      {number}
              * @default   15
-             * @product   highcharts
+             * @product   highcharts gantt
              * @apioption xAxis.labels.distance
              */
 
@@ -841,7 +861,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * @sample {highstock} stock/xaxis/labels-enabled/
              *         X axis labels disabled
              *
-             * @default {highcharts|highstock} true
+             * @default {highcharts|highstock|gantt} true
              * @default {highmaps} false
              */
             enabled: true,
@@ -883,6 +903,18 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * @apioption xAxis.labels.formatter
              */
 
+            /**
+             * The number of pixels to indent the labels per level in a treegrid
+             * axis.
+             *
+             * @product gantt
+             * @sample  gantt/treegrid-axis/demo
+             *          Indentation 10px by default.
+             * @sample  gantt/treegrid-axis/indentation-0px
+             *          Indentation set to 0px.
+             */
+            indentation: 10,
+
             /**
              * Horizontal axis only. When `staggerLines` is not set,
              * `maxStaggerLines` defines how many lines the axis is allowed to
@@ -893,7 +925,6 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * @type      {number}
              * @default   5
              * @since     1.3.3
-             * @product   highstock highmaps
              * @apioption xAxis.labels.maxStaggerLines
              */
 
@@ -916,7 +947,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              *
              * @type      {number}
              * @default   5
-             * @product   highcharts
+             * @product   highcharts gantt
              * @apioption xAxis.labels.padding
              */
 
@@ -941,7 +972,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              *
              * @type      {boolean}
              * @since     4.1.10
-             * @product   highcharts
+             * @product   highcharts gantt
              * @apioption xAxis.labels.reserveSpace
              */
 
@@ -1049,7 +1080,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     2.0.2
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.linkedTo
          */
 
@@ -1264,7 +1295,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @default    {highcharts} 0.01
          * @default    {highstock|highmaps} 0
          * @since      1.2.0
-         * @product    highcharts highstock
+         * @product    highcharts highstock gantt
          */
         minPadding: 0.01,
 
@@ -1502,7 +1533,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {boolean}
          * @default   true
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.showLastLabel
          */
 
@@ -1516,7 +1547,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     5.0.1
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.softMax
          */
 
@@ -1530,7 +1561,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     5.0.1
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.softMin
          */
 
@@ -1547,7 +1578,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @sample {highstock} stock/xaxis/startofweek-0
          *         Sunday
          *
-         * @product highcharts highstock
+         * @product highcharts highstock gantt
          */
         startOfWeek: 1,
 
@@ -1586,7 +1617,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     4.1.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.tickAmount
          */
 
@@ -1665,7 +1696,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @sample {highcharts} highcharts/xaxis/tickmarkplacement-on/
          *         "on"
          *
-         * @product    highcharts
+         * @product    highcharts gantt
          * @validvalue [null, "on", "between"]
          */
         tickmarkPlacement: 'between',
@@ -1794,7 +1825,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * @type      {boolean}
              * @default   true
              * @since     5.0.11
-             * @product   highcharts highstock
+             * @product   highcharts highstock gantt
              * @apioption xAxis.title.reserveSpace
              */
 
@@ -1855,7 +1886,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              *
              * @type      {boolean}
              * @default   false
-             * @product   highcharts highstock
+             * @product   highcharts highstock gantt
              * @apioption xAxis.title.useHTML
              */
 
@@ -1865,7 +1896,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * @type      {number}
              * @default   0
              * @since     4.1.6
-             * @product   highcharts highstock
+             * @product   highcharts highstock gantt
              * @apioption xAxis.title.x
              */
 
@@ -1873,7 +1904,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * Vertical pixel offset of the title position.
              *
              * @type      {number}
-             * @product   highcharts highstock
+             * @product   highcharts highstock gantt
              * @apioption xAxis.title.y
              */
 
@@ -1920,11 +1951,34 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @sample {highcharts} highcharts/yaxis/type-log-negative/
          *         Logarithmic with extension to emulate negative values
          *
-         * @product    highcharts
+         * @product    highcharts gantt
          * @validvalue ["linear", "logarithmic", "datetime", "category"]
          */
         type: 'linear',
 
+        /**
+         * The type of axis. Can be one of `linear`, `logarithmic`, `datetime`,
+         * `category` or `treegrid`. Defaults to `treegrid` for Gantt charts,
+         * `linear` for other chart types.
+         *
+         * In a datetime axis, the numbers are given in milliseconds, and tick
+         * marks are placed on appropriate values, like full hours or days. In a
+         * category or treegrid axis, the [point names](#series.line.data.name)
+         * of the chart's series are used for categories, if a
+         * [categories](#xAxis.categories) array is not defined.
+         *
+         * @sample {highcharts} highcharts/yaxis/type-log-minorgrid/
+         *         Logarithmic with minor grid lines
+         * @sample {highcharts} highcharts/yaxis/type-log-negative/
+         *         Logarithmic with extension to emulate negative values
+         *
+         * @product    highcharts gantt
+         * @validvalue ["linear", "logarithmic", "datetime", "category", "treegrid"]
+         * @default {highcharts} linear
+         * @default {gantt} treegrid
+         * @apioption yAxis.type
+         */
+
         /**
          * Applies only when the axis `type` is `category`. When `uniqueNames`
          * is true, points are placed on the X axis according to their names.
@@ -1942,7 +1996,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @type      {boolean}
          * @default   true
          * @since     4.2.7
-         * @product   highcharts
+         * @product   highcharts gantt
          * @apioption xAxis.uniqueNames
          */
 
@@ -1979,7 +2033,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * ]]</pre>
          *
          * @type      {Array<Array<string|Array<number>>>}
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.units
          */
 
@@ -1990,7 +2044,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @type      {boolean}
          * @default   true
          * @since     4.1.9
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption xAxis.visible
          */
 
@@ -2008,7 +2062,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
      * access to the axis.
      *
      * @extends      xAxis
-     * @excluding    ordinal, overscroll
+     * @excluding    ordinal,overscroll,currentDateIndicator
      * @optionparent yAxis
      */
     defaultYAxisOptions: {
@@ -2102,6 +2156,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @default   {highcharts} false
          * @default   {highstock} false
          * @default   {highmaps} true
+         * @default   {gantt} true
          * @apioption yAxis.reversed
          */
 
@@ -2153,7 +2208,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @default   0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption yAxis.tickWidth
          */
 
@@ -2201,7 +2256,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *         Greater min- and maxPadding
          *
          * @since   1.2.0
-         * @product highcharts highstock
+         * @product highcharts highstock gantt
          */
         maxPadding: 0.05,
 
@@ -2218,7 +2273,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *         Greater min- and maxPadding
          *
          * @since   1.2.0
-         * @product highcharts highstock
+         * @product highcharts highstock gantt
          */
         minPadding: 0.05,
 
@@ -2234,7 +2289,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          * @type      {boolean}
          * @default   {highstock} true
          * @default   {highcharts} false
-         * @product   highstock highcharts
+         * @product   highstock highcharts gantt
          * @apioption yAxis.opposite
          */
 
@@ -2404,7 +2459,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     5.0.1
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption yAxis.softMax
          */
 
@@ -2422,7 +2477,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *
          * @type      {number}
          * @since     5.0.1
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption yAxis.softMin
          */
 
@@ -2559,7 +2614,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
          *          False for Y axis
          *
          * @since   1.2.0
-         * @product highcharts highstock
+         * @product highcharts highstock gantt
          */
         startOnTick: true,
 
@@ -2597,7 +2652,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              *
              * @default {highcharts} Values
              * @default {highstock} undefined
-             * @product highcharts highstock
+             * @product highcharts highstock gantt
              */
             text: 'Values'
         },
@@ -2874,10 +2929,25 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
         // Flag, if axis is linked to another axis
         axis.isLinked = defined(options.linkedTo);
 
-        // Major ticks
+        /**
+         * List of major ticks mapped by postition on axis.
+         *
+         * @name ticks
+         * @memberOf Axis
+         * @type {Object.<number, Highcharts.Tick>}
+         * @see  Highcharts.Tick
+         */
         axis.ticks = {};
         axis.labelEdge = [];
-        // Minor ticks
+        /**
+         * List of minor ticks mapped by position on the axis.
+         *
+         * @name minorTicks
+         * @memberOf Axis
+         * @type {Object.<number, Highcharts.Tick>}
+         *
+         * @see  Highcharts.Tick
+         */
         axis.minorTicks = {};
 
         // List of plotLines/Bands
@@ -3351,9 +3421,11 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
      * @param {boolean} [old=false]
      *        Use old coordinates (for resizing and rescaling).
      *
-     * @param {boolean} [force=false]
+     * @param {boolean|string} [force=false]
      *        If `false`, the function will return null when it falls outside
-     *        the axis bounds.
+     *        the axis bounds. If `true`, the function will return a path
+     *        aligned to the plot area sides if it falls outside. If `pass`, it
+     *        will return a path outside.
      *
      * @param {number} [translatedValue]
      *        If given, return the plot line path of a pixel position on the
@@ -3380,7 +3452,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
              * or skip, depending on the force parameter.
              */
             between = function (x, a, b) {
-                if (x < a || x > b) {
+                if (force !== 'pass' && x < a || x > b) {
                     if (force) {
                         x = Math.min(Math.max(a, x), b);
                     } else {
@@ -3903,7 +3975,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
             axis.oldTransA = transA;
         }
         axis.translationSlope = axis.transA = transA =
-            axis.options.staticScale ||
+            axis.staticScale ||
             axis.len / ((range + pointRangePadding) || 1);
 
         // Translation addend
@@ -5025,7 +5097,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
      * @return {number}
      *         The pixel width allocated to each axis label.
      */
-    getSlotWidth: function () {
+    getSlotWidth: function (tick) {
         // #5086, #1580, #1931
         var chart = this.chart,
             horiz = this.horiz,
@@ -5037,6 +5109,9 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
             marginLeft = chart.margin[3];
 
         return (
+            tick &&
+            tick.slotWidth // Used by grid axis
+        ) || (
             horiz &&
             (labelOptions.step || 0) < 2 &&
             !labelOptions.rotation && // #4415
@@ -5190,11 +5265,14 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
                 label = tick && tick.label,
                 widthOption = labelStyleOptions.width,
                 css = {};
+
             if (label) {
                 // This needs to go before the CSS in old IE (#4502)
                 label.attr(attr);
 
-                if (
+                if (tick.shortenLabel) {
+                    tick.shortenLabel();
+                } else if (
                     commonWidth &&
                     !widthOption &&
                     // Setting width in this case messes with the bounding box
@@ -5229,7 +5307,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
                 delete label.specificTextOverflow;
                 tick.rotation = attr.rotation;
             }
-        });
+        }, this);
 
         // Note: Why is this not part of getLabelPosition?
         this.tickRotCorr = renderer.rotCorr(
@@ -5342,7 +5420,8 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
     },
 
     /**
-     * Render the tick labels to a preliminary position to get their sizes.
+    /**
+     * Render the tick labels to a preliminary position to get their sizes
      *
      * @private
      * @function Highcharts.Axis#getOffset
@@ -5376,7 +5455,7 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
             className = options.className,
             axisParent = axis.axisParent, // Used in color axis
             lineHeightCorrection,
-            tickSize = this.tickSize('tick');
+            tickSize;
 
         // For reuse in Axis.render
         hasData = axis.hasData();
@@ -5502,6 +5581,17 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
 
         axis.axisTitleMargin = pick(titleOffsetOption, labelOffsetPadded);
 
+        if (axis.getMaxLabelDimensions) {
+            axis.maxLabelDimensions = axis.getMaxLabelDimensions(
+                ticks,
+                tickPositions
+            );
+        }
+
+        // Due to GridAxis.tickSize, tickSize should be calculated after ticks
+        // has rendered.
+        tickSize = this.tickSize('tick');
+
         axisOffset[side] = Math.max(
             axisOffset[side],
             axis.axisTitleMargin + titleOffset + directionFactor * axis.offset,
@@ -5693,10 +5783,13 @@ H.extend(Axis.prototype, /** @lends Highcharts.Axis.prototype */{
             if (!ticks[pos]) {
                 ticks[pos] = new Tick(this, pos);
             }
-
+            // NOTE this seems like overkill. Could be handled in tick.render by
+            // setting old position in attr, then set new position in animate.
             // render new ticks in old position
             if (slideInTicks && ticks[pos].isNew) {
-                ticks[pos].render(i, true, 0.1);
+                // Start with negative opacity so that it is visible from
+                // halfway into the animation
+                ticks[pos].render(i, true, -1);
             }
 
             ticks[pos].render(i);