highcharts 6.1.1 → 6.2.0

package/js/es-modules/modules/treemap.src.js

@@ -22,6 +22,7 @@ var seriesType = H.seriesType,
     getColor = mixinTreeSeries.getColor,
     getLevelOptions = mixinTreeSeries.getLevelOptions,
     grep = H.grep,
+    isArray = H.isArray,
     isBoolean = function (x) {
         return typeof x === 'boolean';
     },
@@ -57,7 +58,7 @@ var seriesType = H.seriesType,
  *
  * @sample highcharts/demo/treemap-large-dataset/ Treemap
  *
- * @extends {plotOptions.scatter}
+ * @extends plotOptions.scatter
  * @excluding marker
  * @product highcharts
  * @optionparent plotOptions.treemap
@@ -199,7 +200,7 @@ seriesType('treemap', 'scatter', {
      * @validvalue ["sliceAndDice", "stripes", "squarified", "strip"]
      * @type {String}
      * @see [How to write your own algorithm](
-     * http://www.highcharts.com/docs/chart-and-series-types/treemap).
+     * https://www.highcharts.com/docs/chart-and-series-types/treemap).
      *
      * @sample  {highcharts}
      *          highcharts/plotoptions/treemap-layoutalgorithm-sliceanddice/
@@ -438,39 +439,32 @@ seriesType('treemap', 'scatter', {
 // Prototype members
 }, {
     pointArrayMap: ['value'],
-    axisTypes: seriesTypes.heatmap ?
-        ['xAxis', 'yAxis', 'colorAxis'] :
-        ['xAxis', 'yAxis'],
     directTouch: true,
     optionalAxis: 'colorAxis',
     getSymbol: noop,
     parallelArrays: ['x', 'y', 'value', 'colorValue'],
     colorKey: 'colorValue', // Point color option key
-    translateColors: (
-        seriesTypes.heatmap &&
-        seriesTypes.heatmap.prototype.translateColors
-    ),
-    colorAttribs: (
-        seriesTypes.heatmap &&
-        seriesTypes.heatmap.prototype.colorAttribs
-    ),
     trackerGroups: ['group', 'dataLabelsGroup'],
     /**
      * Creates an object map from parent id to childrens index.
      * @param {Array} data List of points set in options.
      * @param {string} data[].parent Parent id of point.
-     * @param {Array} ids List of all point ids.
+     * @param {Array} existingIds List of all point ids.
      * @return {Object} Map from parent id to children index in data.
      */
-    getListOfParents: function (data, ids) {
-        var listOfParents = reduce(data || [], function (prev, curr, i) {
-            var parent = pick(curr.parent, '');
-            if (prev[parent] === undefined) {
-                prev[parent] = [];
-            }
-            prev[parent].push(i);
-            return prev;
-        }, {});
+    getListOfParents: function (data, existingIds) {
+        var arr = isArray(data) ? data : [],
+            ids = isArray(existingIds) ? existingIds : [],
+            listOfParents = reduce(arr, function (prev, curr, i) {
+                var parent = pick(curr.parent, '');
+                if (prev[parent] === undefined) {
+                    prev[parent] = [];
+                }
+                prev[parent].push(i);
+                return prev;
+            }, {
+                '': [] // Root of tree
+            });
 
         // If parent does not exist, hoist parent to root of tree.
         eachObject(listOfParents, function (children, parent, list) {
@@ -497,7 +491,16 @@ seriesType('treemap', 'scatter', {
         return series.buildNode('', -1, 0, parentList, null);
     },
     init: function (chart, options) {
-        var series = this;
+        var series = this,
+            colorSeriesMixin = H.colorSeriesMixin;
+
+        // If color series logic is loaded, add some properties
+        if (H.colorSeriesMixin) {
+            this.translateColors = colorSeriesMixin.translateColors;
+            this.colorAttribs = colorSeriesMixin.colorAttribs;
+            this.axisTypes = colorSeriesMixin.axisTypes;
+        }
+
         Series.prototype.init.call(series, chart, options);
         if (series.options.allowDrillToNode) {
             H.addEvent(series, 'click', series.onClickDrillToNode);
@@ -1360,8 +1363,8 @@ seriesType('treemap', 'scatter', {
  *  data: [0, 5, 3, 5]
  *  ```
  *
- * 2.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 2.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.treemap.turboThreshold),
  * this option is not available.
  *

package/js/es-modules/modules/variable-pie.src.js

@@ -34,7 +34,7 @@ seriesType('variablepie', 'pie',
      * size (arc) of the slice relates to the Y value and the radius of pie
      * slice relates to the Z value. Requires `highcharts-more.js`.
      *
-     * @extends {plotOptions.pie}
+     * @extends plotOptions.pie
      * @product highcharts
      * @sample {highcharts} highcharts/demo/variable-radius-pie/
      *         Variable-radius pie chart
@@ -432,8 +432,8 @@ seriesType('variablepie', 'pie',
  *  ]
  *  ```
  *
- * 2.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 2.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series'
  * [turboThreshold](#series.variablepie.turboThreshold), this option is not
  * available.

package/js/es-modules/modules/variwide.src.js

@@ -1,17 +1,11 @@
 /**
  * Highcharts variwide module
  *
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
 
-/**
- * To do:
- * - When X axis is not categorized, the scale should reflect how the z values
- *   increase, like a horizontal stack. But then the actual X values aren't
- *   reflected the the axis.. Should we introduce a Z axis too?
- */
 'use strict';
 import H from '../parts/Globals.js';
 import '../parts/AreaSeries.js';
@@ -26,13 +20,15 @@ var addEvent = H.addEvent,
  * A variwide chart (related to marimekko chart) is a column chart with a
  * variable width expressing a third dimension.
  *
- * @extends {plotOptions.column}
+ * @extends plotOptions.column
  * @excluding boostThreshold,crisp,depth,edgeColor,edgeWidth,groupZPadding
  * @product highcharts
  * @sample {highcharts} highcharts/demo/variwide/
  *         Variwide chart
  * @sample {highcharts} highcharts/series-variwide/inverted/
  *         Inverted variwide chart
+ * @sample {highcharts} highcharts/series-variwide/datetime/
+ *         Variwide columns on a datetime axis
  * @since 6.0.0
  * @optionparent plotOptions.variwide
  */
@@ -112,7 +108,8 @@ seriesType('variwide', 'column', {
     translate: function () {
 
         // Temporarily disable crisping when computing original shapeArgs
-        var crispOption = this.options.crisp;
+        var crispOption = this.options.crisp,
+            xAxis = this.xAxis;
         this.options.crisp = false;
 
         seriesTypes.column.prototype.translate.call(this);
@@ -125,16 +122,33 @@ seriesType('variwide', 'column', {
 
         // Distort the points to reflect z dimension
         each(this.points, function (point, i) {
-            var left = this.postTranslate(
+            var left, right;
+
+            if (xAxis.variwide) {
+                left = this.postTranslate(
                     i,
                     point.shapeArgs.x,
                     point
-                ),
+                );
+
                 right = this.postTranslate(
                     i,
                     point.shapeArgs.x + point.shapeArgs.width
                 );
 
+            // For linear or datetime axes, the variwide column should start
+            // with X and extend Z units, without modifying the axis.
+            } else {
+                left = point.plotX;
+                right = xAxis.translate(
+                    point.x + point.z,
+                    0,
+                    0,
+                    0,
+                    1
+                );
+            }
+
             if (this.options.crisp) {
                 left = Math.round(left) - crisp;
                 right = Math.round(right) - crisp;
@@ -146,16 +160,13 @@ seriesType('variwide', 'column', {
             // Crosshair position (#8083)
             point.plotX = (left + right) / 2;
 
+            // Adjust the tooltip position
             if (!inverted) {
-                point.tooltipPos[0] = this.postTranslate(
-                    i,
-                    point.tooltipPos[0]
-                );
+                point.tooltipPos[0] =
+                    point.shapeArgs.x + point.shapeArgs.width / 2;
             } else {
-                point.tooltipPos[1] = this.xAxis.len - this.postTranslate(
-                    i,
-                    this.xAxis.len - point.tooltipPos[1]
-                );
+                point.tooltipPos[1] =
+                    xAxis.len - point.shapeArgs.x - point.shapeArgs.width / 2;
             }
         }, this);
     }
@@ -207,7 +218,7 @@ addEvent(H.Tick, 'afterGetPosition', function (e) {
     var axis = this.axis,
         xOrY = axis.horiz ? 'x' : 'y';
 
-    if (axis.categories && axis.variwide) {
+    if (axis.variwide) {
         this[xOrY + 'Orig'] = e.pos[xOrY];
         this.postTranslate(e.pos, xOrY, this.pos);
     }
@@ -273,8 +284,8 @@ H.wrap(H.Tick.prototype, 'getLabelPosition', function (
  *     ]
  *  ```
  *
- * 2.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 2.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.variwide.turboThreshold),
  * this option is not available.
  *
@@ -312,8 +323,9 @@ H.wrap(H.Tick.prototype, 'getLabelPosition', function (
  */
 
 /**
- * The relative width for each column. The widths are distributed so they sum
- * up to the X axis length.
+ * The relative width for each column. On a category axis, the widths are
+ * distributed so they sum up to the X axis length. On linear and datetime axes,
+ * the columns will be laid out from the X value and Z units along the axis.
  *
  * @type {Number}
  * @product highcharts

package/js/es-modules/modules/vector.src.js

@@ -1,32 +1,45 @@
 /**
  * Vector plot series module
  *
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
 
 'use strict';
+
 import H from '../parts/Globals.js';
 
 var each = H.each,
     seriesType = H.seriesType;
 
+/**
+ * The vector series class.
+ *
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.vector
+ *
+ * @augments Highcharts.seriesTypes.scatter
+ */
+seriesType('vector', 'scatter'
+
 /**
  * A vector plot is a type of cartesian chart where each point has an X and Y
  * position, a length and a direction. Vectors are drawn as arrows.
  *
- * @extends {plotOptions.scatter}
- * @excluding boostThreshold,marker,connectEnds,connectNulls,cropThreshold,
- *            dashStyle,gapSize,gapUnit,dataGrouping,linecap,shadow,stacking,
- *            step
- * @product highcharts highstock
  * @sample {highcharts|highstock} highcharts/demo/vector-plot/
  *         Vector pot
- * @since 6.0.0
+ *
+ * @since        6.0.0
+ * @extends      plotOptions.scatter
+ * @excluding    boostThreshold, marker, connectEnds, connectNulls,
+ *               cropThreshold, dashStyle, gapSize, gapUnit, dataGrouping,
+ *               linecap, shadow, stacking, step
+ * @product      highcharts highstock
  * @optionparent plotOptions.vector
  */
-seriesType('vector', 'scatter', {
+, {
 
     /**
      * The line width for each vector arrow.
@@ -37,28 +50,39 @@ seriesType('vector', 'scatter', {
      * @ignore
      */
     marker: null,
+
     /**
      * What part of the vector it should be rotated around. Can be one of
      * `start`, `center` and `end`. When `start`, the vectors will start from
      * the given [x, y] position, and when `end` the vectors will end in the
      * [x, y] position.
      *
-     * @sample  highcharts/plotoptions/vector-rotationorigin-start/
-     *          Rotate from start
+     * @sample highcharts/plotoptions/vector-rotationorigin-start/
+     *         Rotate from start
+     *
      * @validvalue ["start", "center", "end"]
      */
     rotationOrigin: 'center',
+
     states: {
+
         hover: {
+
             /**
              * Additonal line width for the vector errors when they are hovered.
              */
             lineWidthPlus: 1
         }
     },
+
     tooltip: {
+
+        /**
+         * @default [{point.x}, {point.y}] Length: {point.length} Direction: {point.direction}°
+         */
         pointFormat: '<b>[{point.x}, {point.y}]</b><br/>Length: <b>{point.length}</b><br/>Direction: <b>{point.direction}\u00B0</b><br/>'
     },
+
     /**
      * Maximum length of the arrows in the vector plot. The individual arrow
      * length is computed between 0 and this value.
@@ -66,11 +90,21 @@ seriesType('vector', 'scatter', {
     vectorLength: 20
 
 }, {
+
     pointArrayMap: ['y', 'length', 'direction'],
     parallelArrays: ['x', 'y', 'length', 'direction'],
 
     /**
      * Get presentational attributes.
+     *
+     * @private
+     * @function Highcharts.seriesTypes.vector#pointAttribs
+     *
+     * @param {Highcharts.Point} point
+     *
+     * @param {string} state
+     *
+     * @return {*}
      */
     pointAttribs: function (point, state) {
         var options = this.options,
@@ -89,22 +123,41 @@ seriesType('vector', 'scatter', {
             'stroke-width': strokeWidth
         };
     },
+
+    /**
+     * @ignore
+     * @deprecated
+     * @function Highcharts.seriesTypes.vector#markerAttribs
+     */
     markerAttribs: H.noop,
+
+    /**
+     * @ignore
+     * @deprecated
+     * @function Highcharts.seriesTypes.vector#getSymbol
+     */
     getSymbol: H.noop,
 
     /**
      * Create a single arrow. It is later rotated around the zero
      * centerpoint.
+     *
+     * @private
+     * @function Highcharts.seriesTypes.vector#arrow
+     *
+     * @param {Highcharts.Point} point
+     *
+     * @return {Highcharts.SVGPathArray}
      */
     arrow: function (point) {
         var path,
             fraction = point.length / this.lengthMax,
+            u = fraction * this.options.vectorLength / 20,
             o = {
-                start: 10,
+                start: 10 * u,
                 center: 0,
-                end: -10
-            }[this.options.rotationOrigin] || 0,
-            u = fraction * this.options.vectorLength / 20;
+                end: -10 * u
+            }[this.options.rotationOrigin] || 0;
 
         // The stem and the arrow head. Draw the arrow first with rotation 0,
         // which is the arrow pointing down (vector from north to south).
@@ -120,13 +173,20 @@ seriesType('vector', 'scatter', {
         return path;
     },
 
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.vector#translate
+     */
     translate: function () {
         H.Series.prototype.translate.call(this);
 
         this.lengthMax = H.arrayMax(this.lengthData);
     },
 
-
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.vector#drawPoints
+     */
     drawPoints: function () {
 
         var chart = this.chart;
@@ -158,6 +218,11 @@ seriesType('vector', 'scatter', {
         }, this);
     },
 
+    /**
+     * @ignore
+     * @deprecated
+     * @function Highcharts.seriesTypes.vector#drawGraph
+     */
     drawGraph: H.noop,
 
     /*
@@ -190,6 +255,11 @@ seriesType('vector', 'scatter', {
 
     /**
      * Fade in the arrows on initiating series.
+     *
+     * @private
+     * @function Highcharts.seriesTypes.vector#animate
+     *
+     * @param {boolean} [init]
      */
     animate: function (init) {
         if (init) {
@@ -211,10 +281,9 @@ seriesType('vector', 'scatter', {
  * A `vector` series. If the [type](#series.vector.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).
  *
- * @type {Object}
- * @extends series,plotOptions.vector
- * @excluding dataParser,dataURL
- * @product highcharts highstock
+ * @extends   series,plotOptions.vector
+ * @excluding dataParser, dataURL
+ * @product   highcharts highstock
  * @apioption series.vector
  */
 
@@ -234,8 +303,8 @@ seriesType('vector', 'scatter', {
  *     ]
  *  ```
  *
- * 2.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 2.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.area.turboThreshold),
  * this option is not available.
  *
@@ -254,8 +323,6 @@ seriesType('vector', 'scatter', {
  *     }]
  *  ```
  *
- * @type {Array<Object|Array|Number>}
- * @extends series.line.data
  * @sample {highcharts} highcharts/chart/reflow-true/
  *         Numerical values
  * @sample {highcharts} highcharts/series/data-array-of-arrays/
@@ -266,7 +333,10 @@ seriesType('vector', 'scatter', {
  *         Arrays of point.name and y
  * @sample {highcharts} highcharts/series/data-array-of-objects/
  *         Config objects
- * @product highcharts highstock
+ *
+ * @type      {Array<number|Array<number>|*>}
+ * @extends   series.line.data
+ * @product   highcharts highstock
  * @apioption series.vector.data
  */
 
@@ -274,15 +344,15 @@ seriesType('vector', 'scatter', {
  * The length of the vector. The rendered length will relate to the
  * `vectorLength` setting.
  *
- * @type {Number}
- * @product highcharts highstock
+ * @type      {number}
+ * @product   highcharts highstock
  * @apioption series.vector.data.length
  */
 
 /**
  * The vector direction in degrees, where 0 is north (pointing towards south).
  *
- * @type {Number}
- * @product highcharts highstock
+ * @type      {number}
+ * @product   highcharts highstock
  * @apioption series.vector.data.direction
  */

package/js/es-modules/modules/windbarb.src.js

@@ -1,7 +1,7 @@
 /**
  * Wind barb series module
  *
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -18,7 +18,7 @@ var each = H.each,
  * graphical form. Wind direction is given by the stem direction, and wind speed
  * by the number and shape of barbs.
  *
- * @extends {plotOptions.column}
+ * @extends plotOptions.column
  * @excluding boostThreshold,marker,connectEnds,connectNulls,cropThreshold,
  *            dashStyle,gapSize,gapUnit,dataGrouping,linecap,shadow,stacking,
  *            step
@@ -326,8 +326,8 @@ seriesType('windbarb', 'column', {
  *     ]
  *  ```
  *
- * 2.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 2.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.area.turboThreshold),
  * this option is not available.
  *