highcharts 6.1.4 → 6.2.0

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

@@ -6,7 +6,9 @@
  *
  * License: www.highcharts.com/license
  */
+
 'use strict';
+
 import H from '../parts/Globals.js';
 import '../parts-map/HeatmapSeries.js';
 
@@ -27,10 +29,22 @@ var seriesType = H.seriesType,
         };
     };
 
-// Map of shape types
+/**
+ * Map of shape types.
+ *
+ * @private
+ * @name Highcharts.tileShapeTypes
+ * @type {*}
+ */
 H.tileShapeTypes = {
 
-    /** Hexagon shape type **/
+    /**
+     * Hexagon shape type.
+     *
+     * @private
+     * @name Highcharts.tileShapeTypes.hexagon
+     * @type {*}
+     */
     hexagon: {
         alignDataLabel: H.seriesTypes.scatter.prototype.alignDataLabel,
         getSeriesPadding: function (series) {
@@ -162,7 +176,13 @@ H.tileShapeTypes = {
     },
 
 
-    /** Diamond shape type **/
+    /**
+     * Diamond shape type.
+     *
+     * @private
+     * @name Highcharts.tileShapeTypes.diamond
+     * @type {*}
+     */
     diamond: {
         alignDataLabel: H.seriesTypes.scatter.prototype.alignDataLabel,
         getSeriesPadding: function (series) {
@@ -279,7 +299,13 @@ H.tileShapeTypes = {
     },
 
 
-    /** Circle shape type **/
+    /**
+     * Circle shape type.
+     *
+     * @private
+     * @name Highcharts.tileShapeTypes.circle
+     * @type {*}
+     */
     circle: {
         alignDataLabel: H.seriesTypes.scatter.prototype.alignDataLabel,
         getSeriesPadding: function (series) {
@@ -409,7 +435,13 @@ H.tileShapeTypes = {
     },
 
 
-    /** Square shape type **/
+    /**
+     * Square shape type.
+     *
+     * @private
+     * @name Highcharts.tileShapeTypes.square
+     * @type {*}
+     */
     square: {
         alignDataLabel: H.seriesTypes.heatmap.prototype.alignDataLabel,
         translate: H.seriesTypes.heatmap.prototype.translate,
@@ -455,12 +487,18 @@ H.wrap(H.Axis.prototype, 'setAxisTranslation', function (proceed) {
     }
 });
 
+/**
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.tilemap
+ *
+ * @augments Highcharts.Series
+ */
+seriesType('tilemap', 'heatmap'
 
 /**
  * A tilemap series is a type of heatmap where the tile shapes are configurable.
  *
- * @extends plotOptions.heatmap
- * @product highcharts highmaps
  * @sample highcharts/demo/honeycomb-usa/
  *         Honeycomb tilemap, USA
  * @sample maps/plotoptions/honeycomb-brazil/
@@ -472,20 +510,30 @@ H.wrap(H.Axis.prototype, 'setAxisTranslation', function (proceed) {
  * @sample maps/demo/circlemap-africa/
  *         Circlemap tilemap, Africa
  * @sample maps/demo/diamondmap
- *           Diamondmap tilemap
- * @since 6.0.0
- * @excluding joinBy, shadow, allAreas, mapData, data
+ *         Diamondmap tilemap
+ *
+ * @extends      plotOptions.heatmap
+ * @since        6.0.0
+ * @excluding    joinBy, shadow, allAreas, mapData, data
+ * @product      highcharts highmaps
  * @optionparent plotOptions.tilemap
  */
-seriesType('tilemap', 'heatmap', {
-// Default options
+, { // Default options
+
     states: {
+
         hover: {
+
             halo: {
+
                 enabled: true,
+
                 size: 2,
+
                 opacity: 0.5,
+
                 attributes: {
+
                     zIndex: 3
                 }
             }
@@ -495,7 +543,8 @@ seriesType('tilemap', 'heatmap', {
     /**
      * The padding between points in the tilemap.
      *
-     * @sample maps/plotoptions/tilemap-pointpadding Point padding on tiles
+     * @sample maps/plotoptions/tilemap-pointpadding
+     *         Point padding on tiles
      */
     pointPadding: 2,
 
@@ -503,39 +552,55 @@ seriesType('tilemap', 'heatmap', {
      * The column size - how many X axis units each column in the tilemap
      * should span. Works as in [Heatmaps](#plotOptions.heatmap.colsize).
      *
-     * @type {Number}
-     * @sample {highcharts} maps/demo/heatmap/ One day
-     * @sample {highmaps} maps/demo/heatmap/ One day
-     * @default 1
-     * @product highcharts highmaps
+     * @sample {highcharts} maps/demo/heatmap/
+     *         One day
+     * @sample {highmaps} maps/demo/heatmap/
+     *         One day
+     *
+     * @type      {number}
+     * @default   1
+     * @product   highcharts highmaps
      * @apioption plotOptions.tilemap.colsize
      */
 
     /**
-      * The row size - how many Y axis units each tilemap row should span.
+     * The row size - how many Y axis units each tilemap row should span.
      * Analogous to [colsize](#plotOptions.tilemap.colsize).
-      *
-      * @type {Number}
-      * @sample {highcharts} maps/demo/heatmap/ 1 by default
-      * @sample {highmaps} maps/demo/heatmap/ 1 by default
-      * @default 1
-      * @product highcharts highmaps
-      * @apioption plotOptions.tilemap.rowsize
-      */
+     *
+     * @sample {highcharts} maps/demo/heatmap/
+     *         1 by default
+     * @sample {highmaps} maps/demo/heatmap/
+     *         1 by default
+     *
+     * @type      {number}
+     * @default   1
+     * @product   highcharts highmaps
+     * @apioption plotOptions.tilemap.rowsize
+     */
 
     /**
      * The shape of the tiles in the tilemap. Possible values are `hexagon`,
      * `circle`, `diamond`, and `square`.
      *
-     * @sample maps/demo/circlemap-africa Circular tile shapes
-     * @sample maps/demo/diamondmap Diamond tile shapes
+     * @sample maps/demo/circlemap-africa
+     *         Circular tile shapes
+     * @sample maps/demo/diamondmap
+     *         Diamond tile shapes
+     *
+     * @validvalue ["circle", "diamond", "hexagon", "square"]
      */
     tileShape: 'hexagon'
 
-// Prototype functions
-}, {
+}, { // Prototype functions
 
-    // Set tile shape object on series
+    /**
+     * Set tile shape object on series
+     *
+     * @private
+     * @function Highcharts.seriesTypes.tilemap#setOptions
+     *
+     * @return {*}
+     */
     setOptions: function () {
         // Call original function
         var ret = H.seriesTypes.heatmap.prototype.setOptions.apply(this,
@@ -546,14 +611,30 @@ seriesType('tilemap', 'heatmap', {
         return ret;
     },
 
-    // Use the shape's defined data label alignment function
+    /**
+     * Use the shape's defined data label alignment function
+     *
+     * @private
+     * @function Highcharts.seriesTypes.tilemap#alignDataLabel
+     *
+     * @return {*}
+     */
     alignDataLabel: function () {
         return this.tileShape.alignDataLabel.apply(this,
             Array.prototype.slice.call(arguments)
         );
     },
 
-    // Get metrics for padding of axis for this series
+    /**
+     * Get metrics for padding of axis for this series
+     *
+     * @private
+     * @function Highcharts.seriesTypes.tilemap#getSeriesPixelPadding
+     *
+     * @param {Highcharts.Axis} axis
+     *
+     * @return {*}
+     */
     getSeriesPixelPadding: function (axis) {
         var isX = axis.isXAxis,
             padding = this.tileShape.getSeriesPadding(this),
@@ -598,7 +679,12 @@ seriesType('tilemap', 'heatmap', {
         };
     },
 
-    // Use translate from tileShape
+    /**
+     * Use translate from tileShape
+     *
+     * @private
+     * @function Highcharts.seriesTypes.tilemap#translate
+     */
     translate: function () {
         return this.tileShape.translate.apply(this,
             Array.prototype.slice.call(arguments)
@@ -606,6 +692,13 @@ seriesType('tilemap', 'heatmap', {
     }
 
 }, H.extend({
+
+    /**
+     * @private
+     * @function Highcharts.Point#haloPath
+     *
+     * @return {Highcharts.SVGPathArray}
+     */
     haloPath: function () {
         return this.series.tileShape.haloPath.apply(this,
             Array.prototype.slice.call(arguments)
@@ -617,107 +710,111 @@ seriesType('tilemap', 'heatmap', {
  * A `tilemap` series. If the [type](#series.tilemap.type) option is
  * not specified, it is inherited from [chart.type](#chart.type).
  *
- * @type      {Object}
  * @extends   series,plotOptions.tilemap
- * @excluding allAreas,dataParser,dataURL,joinBy,mapData,marker,pointRange,
- *            shadow,stack
+ * @excluding allAreas, dataParser, dataURL, joinBy, mapData, marker,
+ *            pointRange, shadow, stack
  * @product   highcharts highmaps
  * @apioption series.tilemap
  */
 
- /**
-  * An array of data points for the series. For the `tilemap` series
-  * type, points can be given in the following ways:
-  *
-  * 1.  An array of arrays with 3 or 2 values. In this case, the values
-  * correspond to `x,y,value`. If the first value is a string, it is
-  * applied as the name of the point, and the `x` value is inferred.
-  * The `x` value can also be omitted, in which case the inner arrays
-  * should be of length 2\. Then the `x` value is automatically calculated,
-  * either starting at 0 and incremented by 1, or from `pointStart`
-  * and `pointInterval` given in the series options.
-  *
-  *  ```js
-  *     data: [
-  *         [0, 9, 7],
-  *         [1, 10, 4],
-  *         [2, 6, 3]
-  *     ]
-  *  ```
-  *
-  * 2.  An array of objects with named values. The objects are point
-  * configuration objects as seen below. If the total number of data
-  * points exceeds the series' [turboThreshold](#series.tilemap.turboThreshold),
-  * this option is not available.
-  *
-  *  ```js
-  *     data: [{
-  *         x: 1,
-  *         y: 3,
-  *         value: 10,
-  *         name: "Point2",
-  *         color: "#00FF00"
-  *     }, {
-  *         x: 1,
-  *         y: 7,
-  *         value: 10,
-  *         name: "Point1",
-  *         color: "#FF00FF"
-  *     }]
-  *  ```
-  *
-  * Note that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid
-  * coordinates are offset.
-  *
-  * @type {Array<Object|Array>}
-  * @extends series.heatmap.data
-  * @excluding marker
-  * @sample maps/series/tilemap-gridoffset Offset grid coordinates
-  * @sample {highcharts} highcharts/chart/reflow-true/
-  *         Numerical values
-  * @sample {highcharts} highcharts/series/data-array-of-arrays/
-  *         Arrays of numeric x and y
-  * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
-  *         Arrays of datetime x and y
-  * @sample {highcharts} highcharts/series/data-array-of-name-value/
-  *         Arrays of point.name and y
-  * @sample {highcharts} highcharts/series/data-array-of-objects/
-  *         Config objects
-  * @product highcharts highmaps
-  * @apioption series.tilemap.data
-  */
-
-  /**
-   * The color of the point. In tilemaps the point color is rarely set
-   * 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
-   * @apioption plotOptions.tilemap.data.color
-   */
-
-  /**
-   * The x coordinate of the point.
-   *
-   * Note that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid
-   * coordinates are offset.
-   *
-   * @type {Number}
-   * @product highcharts highmaps
-   * @sample maps/series/tilemap-gridoffset Offset grid coordinates
-   * @apioption plotOptions.tilemap.data.x
-   */
-
-  /**
-   * The y coordinate of the point.
-   *
-   * Note that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid
-   * coordinates are offset.
-   *
-   * @type {Number}
-   * @default undefined
-   * @product highcharts highmaps
-   * @sample maps/series/tilemap-gridoffset Offset grid coordinates
-   * @apioption plotOptions.tilemap.data.y
-   */
+/**
+ * An array of data points for the series. For the `tilemap` series
+ * type, points can be given in the following ways:
+ *
+ * 1.  An array of arrays with 3 or 2 values. In this case, the values
+ * correspond to `x,y,value`. If the first value is a string, it is
+ * applied as the name of the point, and the `x` value is inferred.
+ * The `x` value can also be omitted, in which case the inner arrays
+ * should be of length 2\. Then the `x` value is automatically calculated,
+ * either starting at 0 and incremented by 1, or from `pointStart`
+ * and `pointInterval` given in the series options.
+ *
+ *  ```js
+ *     data: [
+ *         [0, 9, 7],
+ *         [1, 10, 4],
+ *         [2, 6, 3]
+ *     ]
+ *  ```
+ *
+ * 2.  An array of objects with named values. The objects are point
+ * configuration objects as seen below. If the total number of data
+ * points exceeds the series' [turboThreshold](#series.tilemap.turboThreshold),
+ * this option is not available.
+ *
+ *  ```js
+ *     data: [{
+ *         x: 1,
+ *         y: 3,
+ *         value: 10,
+ *         name: "Point2",
+ *         color: "#00FF00"
+ *     }, {
+ *         x: 1,
+ *         y: 7,
+ *         value: 10,
+ *         name: "Point1",
+ *         color: "#FF00FF"
+ *     }]
+ *  ```
+ *
+ * Note that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid
+ * coordinates are offset.
+ *
+ * @sample maps/series/tilemap-gridoffset
+ *         Offset grid coordinates
+ * @sample {highcharts} highcharts/chart/reflow-true/
+ *         Numerical values
+ * @sample {highcharts} highcharts/series/data-array-of-arrays/
+ *         Arrays of numeric x and y
+ * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
+ *         Arrays of datetime x and y
+ * @sample {highcharts} highcharts/series/data-array-of-name-value/
+ *         Arrays of point.name and y
+ * @sample {highcharts} highcharts/series/data-array-of-objects/
+ *         Config objects
+ *
+ * @type      {Array<Array<number>|*>}
+ * @extends   series.heatmap.data
+ * @excluding marker
+ * @product   highcharts highmaps
+ * @apioption series.tilemap.data
+ */
+
+/**
+ * The color of the point. In tilemaps the point color is rarely set
+ * explicitly, as we use the color to denote the `value`. Options for
+ * this are set in the [colorAxis](#colorAxis) configuration.
+ *
+ * @type      {Highcharts.ColorString}
+ * @product   highcharts highmaps
+ * @apioption series.tilemap.data.color
+ */
+
+/**
+ * The x coordinate of the point.
+ *
+ * Note that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid
+ * coordinates are offset.
+ *
+ * @sample maps/series/tilemap-gridoffset
+ *         Offset grid coordinates
+ *
+ * @type      {number}
+ * @product   highcharts highmaps
+ * @apioption series.tilemap.data.x
+ */
+
+/**
+ * The y coordinate of the point.
+ *
+ * Note that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid
+ * coordinates are offset.
+ *
+ * @sample maps/series/tilemap-gridoffset
+ *         Offset grid coordinates
+ *
+ * @type      {number}
+ * @product   highcharts highmaps
+ * @apioption series.tilemap.data.y
+ */

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

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