highcharts 6.1.1 → 6.2.0

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

@@ -1,15 +1,53 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
 
+/**
+ * Configuration hash for the data label and tooltip formatters.
+ *
+ * @typedef Highcharts.PointLabelObject
+ *
+ * @property {number|string} x
+ *           For categorized axes this property holds the category name for the
+ *           point. For other axes it holds the X value.
+ *
+ * @property {number} [y]
+ *           The y value of the point.
+ *
+ * @property {Highcharts.ColorString} color
+ *           The point's current color.
+ *
+ * @property {number} colorIndex
+ *           The point's current color index, used in styled mode instead of
+ *           `color`. The color index is inserted in class names used for
+ *           styling.
+ *
+ * @property {number|string} key
+ *           The name of the related point.
+ *
+ * @property {Highcharts.Series} series
+ *           The related series.
+ *
+ * @property {Highcharts.Point} point
+ *           The related point.
+ *
+ * @property {number} percentage
+ *           The percentage for related points in a stacked series or pies.
+ *
+ * @property {number} total
+ *           The total of values in either a stack for stacked series, or a pie
+ *           in a pie series.
+ */
+
 'use strict';
+
 import Highcharts from './Globals.js';
 import './Utilities.js';
+
 var Point,
     H = Highcharts,
-
     each = H.each,
     extend = H.extend,
     erase = H.erase,
@@ -18,6 +56,8 @@ var Point,
     isArray = H.isArray,
     isNumber = H.isNumber,
     pick = H.pick,
+    uniqueKey = H.uniqueKey,
+    defined = H.defined,
     removeEvent = H.removeEvent;
 
 /**
@@ -27,20 +67,30 @@ var Point,
  * Highcharts.Series#addPoint} or {@link Highcharts.Series#setData}.
  *
  * @class
+ * @name Highcharts.Point
  */
-
 Highcharts.Point = Point = function () {};
 Highcharts.Point.prototype = {
 
     /**
      * Initialize the point. Called internally based on the `series.data`
      * option.
-     * @param  {Series} series
-     *         The series object containing this point.
-     * @param  {Number|Array|Object} options
-     *         The data in either number, array or object format.
-     * @param  {Number} x Optionally, the X value of the point.
-     * @return {Point} The Point instance.
+     *
+     * @function Highcharts.Point#init
+     *
+     * @param {Highcharts.Series} series
+     *        The series object containing this point.
+     *
+     * @param {number|Array<number>|*} options
+     *        The data in either number, array or object format.
+     *
+     * @param {number} x
+     *        Optionally, the X value of the point.
+     *
+     * @return {Highcharts.Point}
+     *         The Point instance.
+     *
+     * @fires Highcharts.Point#event:afterInit
      */
     init: function (series, options, x) {
 
@@ -52,17 +102,22 @@ Highcharts.Point.prototype = {
         /**
          * The series object associated with the point.
          *
-         * @name series
-         * @memberof Highcharts.Point
-         * @type Highcharts.Series
+         * @name Highcharts.Point#series
+         * @type {Highcharts.Series}
          */
         point.series = series;
 
         
+
         point.applyOptions(options, x);
 
+        // Add a unique ID to the point if none is assigned
+        point.id = defined(point.id) ? point.id : uniqueKey();
+
         if (series.options.colorByPoint) {
+
             
+
             colorIndex = series.colorCounter;
             series.colorCounter++;
             // loop back to zero
@@ -76,9 +131,9 @@ Highcharts.Point.prototype = {
         /**
          * The point's current color index, used in styled mode instead of
          * `color`. The color index is inserted in class names used for styling.
-         * @name colorIndex
-         * @memberof Highcharts.Point
-         * @type {Number}
+         *
+         * @name Highcharts.Point#colorIndex
+         * @type {number}
          */
         point.colorIndex = pick(point.colorIndex, colorIndex);
 
@@ -93,9 +148,16 @@ Highcharts.Point.prototype = {
      * properties. Called on point init or from point.update.
      *
      * @private
-     * @param {Object} options The point options as defined in series.data.
-     * @param {Number} x Optionally, the X value.
-     * @returns {Object} The Point instance.
+     * @function Highcharts.Point#applyOptions
+     *
+     * @param {*} options
+     *        The point options as defined in series.data.
+     *
+     * @param {number} x
+     *        Optionally, the x value.
+     *
+     * @return {Highcharts.Point}
+     *         The Point instance.
      */
     applyOptions: function (options, x) {
         var point = this,
@@ -106,6 +168,14 @@ Highcharts.Point.prototype = {
 
         // copy options directly to point
         extend(point, options);
+
+        /**
+         * The point's options as applied in the initial configuration, or
+         * extended through `Point.update`.
+         *
+         * @name Highcharts.Point#options
+         * @type {*}
+         */
         point.options = point.options ?
             extend(point.options, options) :
             options;
@@ -115,7 +185,16 @@ Highcharts.Point.prototype = {
         if (options.group) {
             delete point.group;
         }
+        if (options.dataLabels) {
+            delete point.dataLabels;
+        }
 
+        /**
+         * The y value of the point.
+         *
+         * @name Highcharts.Point#y
+         * @type {number|undefined}
+         */
         // For higher dimension series types. For instance, for ranges, point.y
         // is mapped to point.low.
         if (pointValKey) {
@@ -131,6 +210,12 @@ Highcharts.Point.prototype = {
             point.state = 'select';
         }
 
+        /**
+         * The x value of the point.
+         *
+         * @name Highcharts.Point#x
+         * @type {number}
+         */
         // If no x is set by now, get auto incremented value. All points must
         // have an x value, however the y value can be null to create a gap in
         // the series
@@ -158,11 +243,19 @@ Highcharts.Point.prototype = {
      * supports nested properties using dot notation. The function modifies the
      * input object and does not make a copy.
      *
-     * @param  {Object} object The object to set the value on.
-     * @param  {Mixed} value The value to set.
-     * @param  {String} key Key to the property to set.
+     * @function Highcharts.Point#setNestedProperty
+     *
+     * @param {*} object
+     *        The object to set the value on.
+     *
+     * @param {*} value
+     *        The value to set.
      *
-     * @return {Object} The modified object.
+     * @param {string} key
+     *        Key to the property to set.
+     *
+     * @return {*}
+     *         The modified object.
      */
     setNestedProperty: function (object, value, key) {
         var nestedKeys = key.split('.');
@@ -185,9 +278,13 @@ Highcharts.Point.prototype = {
      * array config like `[1, 10]` in a scatter series will be transformed to
      * `{ x: 1, y: 10 }`.
      *
-     * @param  {Number|Array|Object} options
-     *         The input options
-     * @return {Object} Transformed options.
+     * @function Highcharts.Point#optionsToObject
+     *
+     * @param {number|Array<number>|*} options
+     *        The input option.
+     *
+     * @return {*}
+     *         Transformed options.
      */
     optionsToObject: function (options) {
         var ret = {},
@@ -251,7 +348,10 @@ Highcharts.Point.prototype = {
      * Get the CSS class names for individual points. Used internally where the
      * returned value is set on every point.
      *
-     * @returns {String} The class names.
+     * @function Highcharts.Point#getClassName
+     *
+     * @return {string}
+     *         The class names.
      */
     getClassName: function () {
         return 'highcharts-point' +
@@ -268,7 +368,9 @@ Highcharts.Point.prototype = {
     /**
      * In a series with `zones`, return the zone that the point belongs to.
      *
-     * @return {Object}
+     * @function Highcharts.Point#getZone
+     *
+     * @return {Highcharts.PlotSeriesZonesOptions}
      *         The zone item.
      */
     getZone: function () {
@@ -302,6 +404,7 @@ Highcharts.Point.prototype = {
      * `series.data`.
      *
      * @private
+     * @function Highcharts.Point#destroy
      */
     destroy: function () {
         var point = this,
@@ -324,8 +427,8 @@ Highcharts.Point.prototype = {
             point.onMouseOut();
         }
 
-        // Remove all events
-        if (point.graphic || point.dataLabel) {
+        // Remove all events and elements
+        if (point.graphic || point.dataLabel || point.dataLabels) {
             removeEvent(point);
             point.destroyElements();
         }
@@ -337,14 +440,13 @@ Highcharts.Point.prototype = {
         for (prop in point) {
             point[prop] = null;
         }
-
-
     },
 
     /**
      * Destroy SVG elements associated with the point.
      *
      * @private
+     * @function Highcharts.Point#destroyElements
      */
     destroyElements: function () {
         var point = this,
@@ -363,14 +465,33 @@ Highcharts.Point.prototype = {
                 point[prop] = point[prop].destroy();
             }
         }
+        // Handle point.dataLabels and point.connectors
+        if (point.dataLabels) {
+            each(point.dataLabels, function (label) {
+                if (label.element) {
+                    label.destroy();
+                }
+            });
+            delete point.dataLabels;
+        }
+        if (point.connectors) {
+            each(point.connectors, function (connector) {
+                if (connector.element) {
+                    connector.destroy();
+                }
+            });
+            delete point.connectors;
+        }
     },
 
     /**
      * Return the configuration hash needed for the data label and tooltip
      * formatters.
      *
-     * @returns {Object}
-     *          Abstract object used in formatters and formats.
+     * @function Highcharts.Point#getLabelConfig
+     *
+     * @return {Highcharts.PointLabelObject}
+     *         Abstract object used in formatters and formats.
      */
     getLabelConfig: function () {
         return {
@@ -389,9 +510,12 @@ Highcharts.Point.prototype = {
     /**
      * Extendable method for formatting each point's tooltip line.
      *
-     * @param  {String} pointFormat
-     *         The point format.
-     * @return {String}
+     * @function Highcharts.Point#tooltipFormatter
+     *
+     * @param {string} pointFormat
+     *        The point format.
+     *
+     * @return {string}
      *         A string to be concatenated in to the common tooltip text.
      */
     tooltipFormatter: function (pointFormat) {
@@ -429,9 +553,18 @@ Highcharts.Point.prototype = {
      * Fire an event on the Point object.
      *
      * @private
-     * @param {String} eventType
-     * @param {Object} eventArgs Additional event arguments
-     * @param {Function} defaultFunction Default event handler
+     * @function Highcharts.Point#firePointEvent
+     *
+     * @param {string} eventType
+     *        Type of the event.
+     *
+     * @param {*} eventArgs
+     *        Additional event arguments.
+     *
+     * @param {Function} defaultFunction
+     *        Default event handler.
+     *
+     * @fires Highcharts.Point#event:*
      */
     firePointEvent: function (eventType, eventArgs, defaultFunction) {
         var point = this,
@@ -471,9 +604,8 @@ Highcharts.Point.prototype = {
      * For certain series types, like pie charts, where individual points can
      * be shown or hidden.
      *
-     * @name visible
-     * @memberof Highcharts.Point
-     * @type {Boolean}
+     * @name Highcharts.Point#visible
+     * @type {boolean}
      */
     visible: true
 };
@@ -482,9 +614,8 @@ Highcharts.Point.prototype = {
  * For categorized axes this property holds the category name for the
  * point. For other axes it holds the X value.
  *
- * @name category
- * @memberof Highcharts.Point
- * @type {String|Number}
+ * @name Highcharts.Point#category
+ * @type {number|string}
  */
 
 /**
@@ -507,41 +638,22 @@ Highcharts.Point.prototype = {
  *     y: 2
  * }]
  *
- * @name name
- * @memberof Highcharts.Point
- * @type {String}
+ * @name Highcharts.Point#name
+ * @type {string}
  */
 
 
 /**
  * The percentage for points in a stacked series or pies.
  *
- * @name percentage
- * @memberof Highcharts.Point
- * @type {Number}
+ * @name Highcharts.Point#percentage
+ * @type {number}
  */
 
 /**
  * The total of values in either a stack for stacked series, or a pie in a pie
  * series.
  *
- * @name total
- * @memberof Highcharts.Point
- * @type {Number}
- */
-
-/**
- * The x value of the point.
- *
- * @name x
- * @memberof Highcharts.Point
- * @type {Number}
- */
-
-/**
- * The y value of the point.
- *
- * @name y
- * @memberof Highcharts.Point
- * @type {Number}
+ * @name Highcharts.Point#total
+ * @type {number}
  */