highcharts 6.1.1 → 6.2.0

package/js/es-modules/parts-map/ColorAxis.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -43,7 +43,7 @@ if (!H.ColorAxis) {
          * classes.
          *
          * For supported color formats, see the
-         * [docs article about colors](http://www.highcharts.com/docs/chart-design-and-style/colors).
+         * [docs article about colors](https://www.highcharts.com/docs/chart-design-and-style/colors).
          *
          * A scalar color axis is represented by a gradient. The colors either
          * range between the [minColor](#colorAxis.minColor) and the
@@ -64,7 +64,7 @@ if (!H.ColorAxis) {
          * See [the Axis object](/class-reference/Highcharts.Axis) for
          * programmatic access to the axis.
          *
-         * @extends {xAxis}
+         * @extends xAxis
          * @excluding allowDecimals,alternateGridColor,breaks,categories,
          *            crosshair,dateTimeLabelFormats,lineWidth,linkedTo,maxZoom,
          *            minRange,minTickInterval,offset,opposite,plotBands,
@@ -293,7 +293,7 @@ if (!H.ColorAxis) {
                  * Animation for the marker as it moves between values. Set to
                  * `false` to disable animation. Defaults to `{ duration: 50 }`.
                  *
-                 * @type {Object|Boolean}
+                 * @type {AnimationOptions|Boolean}
                  * @product highcharts highmaps
                  */
                 animation: {
@@ -910,7 +910,6 @@ if (!H.ColorAxis) {
                                     }
                                 });
                             });
-
                             chart.legend.colorizeItem(this, vis);
                         }
                     }, dataClass));

package/js/es-modules/parts-map/ColorSeriesMixin.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -35,6 +35,8 @@ H.colorPointMixin = {
         var point = this,
             method = vis ? 'show' : 'hide';
 
+        point.visible = Boolean(vis);
+
         // Show and hide associated elements
         each(['graphic', 'dataLabel'], function (key) {
             if (point[key]) {

package/js/es-modules/parts-map/GeoJSON.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */

package/js/es-modules/parts-map/HeatmapSeries.js

@@ -1,9 +1,11 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
+
 'use strict';
+
 import H from '../parts/Globals.js';
 import '../parts/Utilities.js';
 import '../parts/Options.js';
@@ -11,6 +13,7 @@ import '../parts/Point.js';
 import '../parts/Series.js';
 import '../parts/Legend.js';
 import './ColorSeriesMixin.js';
+
 var colorPointMixin = H.colorPointMixin,
     colorSeriesMixin = H.colorSeriesMixin,
     each = H.each,
@@ -22,29 +25,36 @@ var colorPointMixin = H.colorPointMixin,
     seriesType = H.seriesType,
     seriesTypes = H.seriesTypes;
 
+/**
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.heatmap
+ *
+ * @augments Highcharts.Series
+ */
+seriesType('heatmap', 'scatter'
 
 /**
  * A heatmap is a graphical representation of data where the individual values
  * contained in a matrix are represented as colors.
  *
- * @sample       highcharts/demo/heatmap/
- *               Simple heatmap
- * @sample       highcharts/demo/heatmap-canvas/
- *               Heavy heatmap
+ * @sample highcharts/demo/heatmap/
+ *         Simple heatmap
+ * @sample highcharts/demo/heatmap-canvas/
+ *         Heavy heatmap
+ *
  * @extends      {plotOptions.scatter}
- * @excluding    animationLimit,connectEnds,connectNulls,dashStyle,
- *               findNearestPointBy,getExtremesFromAll,linecap,lineWidth,marker,
- *               pointInterval,pointIntervalUnit,pointRange,pointStart,shadow,
- *               softThreshold,stacking,step,threshold
+ * @excluding    animationLimit, connectEnds, connectNulls, dashStyle,
+ *               findNearestPointBy, getExtremesFromAll, linecap, lineWidth,
+ *               marker, pointInterval, pointIntervalUnit, pointRange,
+ *               pointStart, shadow, softThreshold, stacking, step, threshold
  * @product      highcharts highmaps
  * @optionparent plotOptions.heatmap
  */
-seriesType('heatmap', 'scatter', {
+, {
 
     /**
      * Animation is disabled by default on the heatmap series.
-     *
-     * @type {Boolean|Object}
      */
     animation: false,
 
@@ -56,9 +66,9 @@ seriesType('heatmap', 'scatter', {
     /**
      * Padding between the points in the heatmap.
      *
-     * @type {Number}
-     * @default 0
-     * @since 6.0
+     * @type      {number}
+     * @default   0
+     * @since     6.0
      * @apioption plotOptions.heatmap.pointPadding
      */
 
@@ -68,10 +78,9 @@ seriesType('heatmap', 'scatter', {
      * options are set in the [colorAxis](#colorAxis), the default value
      * is pulled from the [options.colors](#colors) array.
      *
-     * @type {Color}
-     * @default null
-     * @since 4.0
-     * @product highcharts
+     * @type      {Highcharts.ColorString}
+     * @since     4.0
+     * @product   highcharts
      * @apioption plotOptions.heatmap.color
      */
 
@@ -79,31 +88,36 @@ seriesType('heatmap', 'scatter', {
      * The column size - how many X axis units each column in the heatmap
      * should span.
      *
-     * @type {Number}
-     * @sample {highcharts} maps/demo/heatmap/ One day
-     * @sample {highmaps} maps/demo/heatmap/ One day
-     * @default 1
-     * @since 4.0
-     * @product highcharts highmaps
+     * @sample {highcharts} maps/demo/heatmap/
+     *         One day
+     * @sample {highmaps} maps/demo/heatmap/
+     *         One day
+     *
+     * @type      {number}
+     * @default   1
+     * @since     4.0
+     * @product   highcharts highmaps
      * @apioption plotOptions.heatmap.colsize
      */
 
     /**
      * The row size - how many Y axis units each heatmap row should span.
      *
-     * @type {Number}
-     * @sample {highcharts} maps/demo/heatmap/ 1 by default
-     * @sample {highmaps} maps/demo/heatmap/ 1 by default
-     * @default 1
-     * @since 4.0
-     * @product highcharts highmaps
+     * @sample {highcharts} maps/demo/heatmap/
+     *         1 by default
+     * @sample {highmaps} maps/demo/heatmap/
+     *         1 by default
+     *
+     * @type      {number}
+     * @default   1
+     * @since     4.0
+     * @product   highcharts highmaps
      * @apioption plotOptions.heatmap.rowsize
      */
 
     
 
     dataLabels: {
-
         formatter: function () { // #2945
             return this.point.value;
         },
@@ -119,7 +133,9 @@ seriesType('heatmap', 'scatter', {
      */
     marker: null,
 
-    /**    @ignore */
+    /**
+     * @ignore
+     */
     pointRange: null, // dynamically set to colsize by default
 
     tooltip: {
@@ -129,6 +145,7 @@ seriesType('heatmap', 'scatter', {
     states: {
 
         hover: {
+
             /**
              * @ignore
              */
@@ -141,14 +158,15 @@ seriesType('heatmap', 'scatter', {
              * In styled mode, the hover brightening is by default replaced
              * with a fill-opacity set in the `.highcharts-point:hover` rule.
              *
-             * @type {Number}
              * @product highcharts highmaps
              */
             brightness: 0.2
         }
+
     }
 
 }, merge(colorSeriesMixin, {
+
     pointArrayMap: ['y', 'value'],
     hasPointSpecificOptions: true,
     getExtremesFromAll: true,
@@ -156,6 +174,9 @@ seriesType('heatmap', 'scatter', {
 
     /**
      * Override the init method to add point ranges on both axes.
+     *
+     * @private
+     * @function Highcharts.seriesTypes.heatmap#init
      */
     init: function () {
         var options;
@@ -166,6 +187,11 @@ seriesType('heatmap', 'scatter', {
         options.pointRange = pick(options.pointRange, options.colsize || 1);
         this.yAxis.axisPointRange = options.rowsize || 1; // general point range
     },
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.heatmap#translate
+     */
     translate: function () {
         var series = this,
             options = series.options,
@@ -220,6 +246,11 @@ seriesType('heatmap', 'scatter', {
 
         series.translateColors();
     },
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.heatmap#drawPoints
+     */
     drawPoints: function () {
         seriesTypes.column.prototype.drawPoints.call(this);
 
@@ -231,10 +262,37 @@ seriesType('heatmap', 'scatter', {
             
         }, this);
     },
+
+    /**
+     * @ignore
+     * @deprecated
+     * @function Highcharts.seriesTypes.heatmap#animate
+     */
     animate: noop,
+
+    /**
+     * @ignore
+     * @deprecated
+     * @function Highcharts.seriesTypes.heatmap#getBox
+     */
     getBox: noop,
+
+    /**
+     * @private
+     * @borrows Highcharts.LegendSymbolMixin.drawRectangle as Highcharts.seriesTypes.heatmap#drawLegendSymbol
+     */
     drawLegendSymbol: LegendSymbolMixin.drawRectangle,
+
+    /**
+     * @private
+     * @borrows Highcharts.seriesTypes.column#alignDataLabel as Highcharts.seriesTypes.heatmap#alignDataLabel
+     */
     alignDataLabel: seriesTypes.column.prototype.alignDataLabel,
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.heatmap#getExtremes
+     */
     getExtremes: function () {
         // Get the extremes from the value data
         Series.prototype.getExtremes.call(this, this.valueData);
@@ -246,6 +304,15 @@ seriesType('heatmap', 'scatter', {
     }
 
 }), H.extend({
+
+    /**
+     * @private
+     * @function Highcharts.Point#haloPath
+     *
+     * @param {number} size
+     *
+     * @return {Highcharts.SVGPathArray}
+     */
     haloPath: function (size) {
         if (!size) {
             return [];
@@ -260,14 +327,14 @@ seriesType('heatmap', 'scatter', {
         ];
     }
 }, colorPointMixin));
+
 /**
  * A `heatmap` series. If the [type](#series.heatmap.type) option is
  * not specified, it is inherited from [chart.type](#chart.type).
  *
- * @type {Object}
- * @extends series,plotOptions.heatmap
- * @excluding dataParser,dataURL,marker,pointRange,stack
- * @product highcharts highmaps
+ * @extends   series,plotOptions.heatmap
+ * @excluding dataParser, dataURL, marker, pointRange, stack
+ * @product   highcharts highmaps
  * @apioption series.heatmap
  */
 
@@ -291,8 +358,8 @@ seriesType('heatmap', '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.heatmap.turboThreshold),
  * this option is not available.
  *
@@ -312,9 +379,6 @@ seriesType('heatmap', 'scatter', {
  *     }]
  *  ```
  *
- * @type {Array<Object|Array>}
- * @extends series.line.data
- * @excluding marker
  * @sample {highcharts} highcharts/chart/reflow-true/
  *         Numerical values
  * @sample {highcharts} highcharts/series/data-array-of-arrays/
@@ -325,7 +389,11 @@ seriesType('heatmap', 'scatter', {
  *         Arrays of point.name and y
  * @sample {highcharts} highcharts/series/data-array-of-objects/
  *         Config objects
- * @product highcharts highmaps
+ *
+ * @type      {Array<Array<number>|*>}
+ * @extends   series.line.data
+ * @excluding marker
+ * @product   highcharts highmaps
  * @apioption series.heatmap.data
  */
 
@@ -334,8 +402,8 @@ seriesType('heatmap', 'scatter', {
  * explicitly, as we use the color to denote the `value`. Options for
  * this are set in the [colorAxis](#colorAxis) configuration.
  *
- * @type {Color}
- * @product highcharts highmaps
+ * @type      {Highcharts.ColorString}
+ * @product   highcharts highmaps
  * @apioption series.heatmap.data.color
  */
 
@@ -343,8 +411,8 @@ seriesType('heatmap', 'scatter', {
  * The value of the point, resulting in a color controled by options
  * as set in the [colorAxis](#colorAxis) configuration.
  *
- * @type {Number}
- * @product highcharts highmaps
+ * @type      {number}
+ * @product   highcharts highmaps
  * @apioption series.heatmap.data.value
  */
 
@@ -352,24 +420,26 @@ seriesType('heatmap', 'scatter', {
  * The x value of the point. For datetime axes,
  * the X value is the timestamp in milliseconds since 1970.
  *
- * @type {Number}
- * @product highcharts highmaps
+ * @type      {number}
+ * @product   highcharts highmaps
  * @apioption series.heatmap.data.x
  */
 
 /**
  * The y value of the point.
  *
- * @type {Number}
- * @product highcharts highmaps
+ * @type      {number}
+ * @product   highcharts highmaps
  * @apioption series.heatmap.data.y
  */
 
 /**
  * Point padding for a single point.
  *
- * @type {Number}
- * @sample maps/plotoptions/tilemap-pointpadding Point padding on tiles
+ * @sample maps/plotoptions/tilemap-pointpadding
+ *         Point padding on tiles
+ *
+ * @type      {number}
  * @apioption series.heatmap.data.pointPadding
  */