highcharts 7.1.1 → 7.1.2

package/es-modules/parts/Point.js

@@ -1,80 +1,68 @@
 /* *
- * (c) 2010-2019 Torstein Honsi
  *
- * License: www.highcharts.com/license
- */
-
+ *  (c) 2010-2019 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import Highcharts from './Globals.js';
 /**
  * Configuration hash for the data label and tooltip formatters.
  *
  * @interface Highcharts.PointLabelObject
- *//**
- * The point's current color.
- * @name Highcharts.PointLabelObject#color
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- *//**
- * 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 Highcharts.PointLabelObject#colorIndex
- * @type {number}
- *//**
- * The name of the related point.
- * @name Highcharts.PointLabelObject#key
- * @type {number|string}
- *//**
- * The percentage for related points in a stacked series or pies.
- * @name Highcharts.PointLabelObject#percentage
- * @type {number}
- *//**
- * The related point.
- * @name Highcharts.PointLabelObject#point
- * @type {Highcharts.Point}
- *//**
- * The related series.
- * @name Highcharts.PointLabelObject#series
- * @type {Highcharts.Series}
- *//**
- * The total of values in either a stack for stacked series, or a pie in a pie
- * series.
- * @name Highcharts.PointLabelObject#total
- * @type {number}
- *//**
- * For categorized axes this property holds the category name for the point. For
- * other axes it holds the X value.
- * @name Highcharts.PointLabelObject#x
- * @type {number|string}
- *//**
- * The y value of the point.
- * @name Highcharts.PointLabelObject#y
- * @type {number|undefined}
- */
-
+ */ /**
+* The point's current color.
+* @name Highcharts.PointLabelObject#color
+* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+*/ /**
+* 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 Highcharts.PointLabelObject#colorIndex
+* @type {number}
+*/ /**
+* The name of the related point.
+* @name Highcharts.PointLabelObject#key
+* @type {number|string}
+*/ /**
+* The percentage for related points in a stacked series or pies.
+* @name Highcharts.PointLabelObject#percentage
+* @type {number}
+*/ /**
+* The related point.
+* @name Highcharts.PointLabelObject#point
+* @type {Highcharts.Point}
+*/ /**
+* The related series.
+* @name Highcharts.PointLabelObject#series
+* @type {Highcharts.Series}
+*/ /**
+* The total of values in either a stack for stacked series, or a pie in a pie
+* series.
+* @name Highcharts.PointLabelObject#total
+* @type {number}
+*/ /**
+* For categorized axes this property holds the category name for the point. For
+* other axes it holds the X value.
+* @name Highcharts.PointLabelObject#x
+* @type {number|string}
+*/ /**
+* The y value of the point.
+* @name Highcharts.PointLabelObject#y
+* @type {number|undefined}
+*/
 /**
  * @interface Highcharts.PointObject
- *//**
- * Custom properties set by custom data options.
- * @name Highcharts.Point#[property:string]
- * @type {*}
- */
-
-'use strict';
-
-import Highcharts from './Globals.js';
+ */ /**
+* Custom properties set by custom data options.
+* @name Highcharts.Point#[property:string]
+* @type {*}
+*/
 import './Utilities.js';
-
-var Point,
-    H = Highcharts,
-    extend = H.extend,
-    erase = H.erase,
-    fireEvent = H.fireEvent,
-    format = H.format,
-    isArray = H.isArray,
-    isNumber = H.isNumber,
-    pick = H.pick,
-    uniqueKey = H.uniqueKey,
-    defined = H.defined,
-    removeEvent = H.removeEvent;
-
+var Point, H = Highcharts, extend = H.extend, erase = H.erase, fireEvent = H.fireEvent, format = H.format, isArray = H.isArray, isNumber = H.isNumber, pick = H.pick, uniqueKey = H.uniqueKey, defined = H.defined, removeEvent = H.removeEvent;
+/* eslint-disable no-invalid-this, valid-jsdoc */
 /**
  * The Point object. The point objects are generated from the `series.data`
  * configuration objects or raw numbers. They can be accessed from the
@@ -85,9 +73,8 @@ var Point,
  * @name Highcharts.Point
  * @implements {Highcharts.PointObject}
  */
-Highcharts.Point = Point = function () {};
+Highcharts.Point = Point = function () { };
 Highcharts.Point.prototype = {
-
     /**
      * Initialize the point. Called internally based on the `series.data`
      * option.
@@ -97,7 +84,7 @@ Highcharts.Point.prototype = {
      * @param {Highcharts.Series} series
      *        The series object containing this point.
      *
-     * @param {number|object|Array<number|string>|null} options
+     * @param {number|object|Array<(number|string)>|null} options
      *        The data in either number, array or object format.
      *
      * @param {number} [x]
@@ -109,7 +96,6 @@ Highcharts.Point.prototype = {
      * @fires Highcharts.Point#event:afterInit
      */
     init: function (series, options, x) {
-
         /**
          * The series object associated with the point.
          *
@@ -117,29 +103,21 @@ Highcharts.Point.prototype = {
          * @type {Highcharts.Series}
          */
         this.series = series;
-
         this.applyOptions(options, x);
-
         // Add a unique ID to the point if none is assigned
         this.id = defined(this.id) ? this.id : uniqueKey();
-
         this.resolveColor();
-
         series.chart.pointCount++;
-
         fireEvent(this, 'afterInit');
-
         return this;
     },
-
+    /**
+     * @private
+     * @function Highcharts.Point#resolveColor
+     * @return {void}
+     */
     resolveColor: function () {
-        var series = this.series,
-            colors,
-            optionsChart = series.chart.options.chart,
-            colorCount = optionsChart.colorCount,
-            styledMode = series.chart.styledMode,
-            colorIndex;
-
+        var series = this.series, colors, optionsChart = series.chart.options.chart, colorCount = optionsChart.colorCount, styledMode = series.chart.styledMode, colorIndex;
         /**
          * The point's current color.
          *
@@ -149,7 +127,6 @@ Highcharts.Point.prototype = {
         if (!styledMode && !this.options.color) {
             this.color = series.color; // #3445
         }
-
         if (series.options.colorByPoint) {
             if (!styledMode) {
                 colors = series.options.colors || series.chart.options.colors;
@@ -162,10 +139,10 @@ Highcharts.Point.prototype = {
             if (series.colorCounter === colorCount) {
                 series.colorCounter = 0;
             }
-        } else {
+        }
+        else {
             colorIndex = series.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.
@@ -175,7 +152,6 @@ Highcharts.Point.prototype = {
          */
         this.colorIndex = pick(this.colorIndex, colorIndex);
     },
-
     /**
      * Apply the options containing the x and y data and possible some extra
      * properties. Called on point init or from point.update.
@@ -183,7 +159,7 @@ Highcharts.Point.prototype = {
      * @private
      * @function Highcharts.Point#applyOptions
      *
-     * @param {number|object|Array<number|string>|null} options
+     * @param {number|Highcharts.Dictionary<any>|Array<(number|string)>|null} options
      *        The point options as defined in series.data.
      *
      * @param {number} [x]
@@ -193,15 +169,10 @@ Highcharts.Point.prototype = {
      *         The Point instance.
      */
     applyOptions: function (options, x) {
-        var point = this,
-            series = point.series,
-            pointValKey = series.options.pointValKey || series.pointValKey;
-
+        var point = this, series = point.series, pointValKey = series.options.pointValKey || series.pointValKey;
         options = Point.prototype.optionsToObject.call(this, options);
-
         // copy options directly to point
         extend(point, options);
-
         /**
          * The point's options as applied in the initial configuration, or
          * extended through `Point.update`.
@@ -211,7 +182,6 @@ Highcharts.Point.prototype = {
         point.options = point.options ?
             extend(point.options, options) :
             options;
-
         // Since options are copied into the Point instance, some accidental
         // options must be shielded (#5681)
         if (options.group) {
@@ -220,7 +190,6 @@ Highcharts.Point.prototype = {
         if (options.dataLabels) {
             delete point.dataLabels;
         }
-
         /**
          * The y value of the point.
          * @name Highcharts.Point#y
@@ -231,20 +200,14 @@ Highcharts.Point.prototype = {
         if (pointValKey) {
             point.y = point[pointValKey];
         }
-        point.isNull = pick(
-            point.isValid && !point.isValid(),
-            point.x === null || !isNumber(point.y, true)
-        ); // #3571, check for NaN
-
+        point.isNull = pick(point.isValid && !point.isValid(), point.x === null || !isNumber(point.y, true)); // #3571, check for NaN
         if (point.isNull) { // #9233
             point.formatPrefix = 'null';
         }
-
         // The point is initially selected by options (#5777)
         if (point.selected) {
             point.state = 'select';
         }
-
         /**
          * The x value of the point.
          * @name Highcharts.Point#x
@@ -253,33 +216,30 @@ Highcharts.Point.prototype = {
         // 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
-        if (
-            'name' in point &&
+        if ('name' in point &&
             x === undefined &&
             series.xAxis &&
-            series.xAxis.hasNames
-        ) {
+            series.xAxis.hasNames) {
             point.x = series.xAxis.nameToX(point);
         }
         if (point.x === undefined && series) {
             if (x === undefined) {
                 point.x = series.autoIncrement(point);
-            } else {
+            }
+            else {
                 point.x = x;
             }
         }
-
         return point;
     },
-
     /**
      * Set a value in an object, on the property defined by key. The key
      * supports nested properties using dot notation. The function modifies the
      * input object and does not make a copy.
      *
-     * @function Highcharts.Point#setNestedProperty
+     * @function Highcharts.Point#setNestedProperty<T>
      *
-     * @param {object} object
+     * @param {T} object
      *        The object to set the value on.
      *
      * @param {*} value
@@ -288,60 +248,50 @@ Highcharts.Point.prototype = {
      * @param {string} key
      *        Key to the property to set.
      *
-     * @return {object}
+     * @return {T}
      *         The modified object.
      */
     setNestedProperty: function (object, value, key) {
         var nestedKeys = key.split('.');
-
         nestedKeys.reduce(function (result, key, i, arr) {
             var isLastKey = arr.length - 1 === i;
-
-            result[key] = (
-                isLastKey ?
-                    value :
-                    (H.isObject(result[key], true) ? result[key] : {})
-            );
+            result[key] = (isLastKey ?
+                value :
+                H.isObject(result[key], true) ?
+                    result[key] :
+                    {});
             return result[key];
         }, object);
         return object;
     },
-
     /**
-     * Transform number or array configs into objects. Used internally to unify
-     * the different configuration formats for points. For example, a simple
-     * number `10` in a line series will be transformed to `{ y: 10 }`, and an
-     * array config like `[1, 10]` in a scatter series will be transformed to
-     * `{ x: 1, y: 10 }`.
+     * Transform number or array configs into objects. Also called for object
+     * configs. Used internally to unify the different configuration formats for
+     * points. For example, a simple number `10` in a line series will be
+     * transformed to `{ y: 10 }`, and an array config like `[1, 10]` in a
+     * scatter series will be transformed to `{ x: 1, y: 10 }`.
      *
      * @function Highcharts.Point#optionsToObject
      *
-     * @param {number|object|Array<number|string>|null} options
+     * @param {number|Highcharts.Dictionary<*>|Array<number|string>|null} options
      *        The input option.
      *
-     * @return {object}
+     * @return {Highcharts.Dictionary<*>}
      *         Transformed options.
      */
     optionsToObject: function (options) {
-        var ret = {},
-            series = this.series,
-            keys = series.options.keys,
-            pointArrayMap = keys || series.pointArrayMap || ['y'],
-            valueCount = pointArrayMap.length,
-            firstItemType,
-            i = 0,
-            j = 0;
-
+        var ret = {}, series = this.series, keys = series.options.keys, pointArrayMap = keys || series.pointArrayMap || ['y'], valueCount = pointArrayMap.length, firstItemType, i = 0, j = 0;
         if (isNumber(options) || options === null) {
             ret[pointArrayMap[0]] = options;
-
-        } else if (isArray(options)) {
+        }
+        else if (isArray(options)) {
             // with leading x value
             if (!keys && options.length > valueCount) {
                 firstItemType = typeof options[0];
                 if (firstItemType === 'string') {
                     ret.name = options[0];
-                } else if (firstItemType === 'number') {
+                }
+                else if (firstItemType === 'number') {
                     ret.x = options[0];
                 }
                 i++;
@@ -352,26 +302,24 @@ Highcharts.Point.prototype = {
                     if (pointArrayMap[j].indexOf('.') > 0) {
                         // Handle nested keys, e.g. ['color.pattern.image']
                         // Avoid function call unless necessary.
-                        H.Point.prototype.setNestedProperty(
-                            ret, options[i], pointArrayMap[j]
-                        );
-                    } else {
+                        H.Point.prototype.setNestedProperty(ret, options[i], pointArrayMap[j]);
+                    }
+                    else {
                         ret[pointArrayMap[j]] = options[i];
                     }
                 }
                 i++;
                 j++;
             }
-        } else if (typeof options === 'object') {
+        }
+        else if (typeof options === 'object') {
             ret = options;
-
             // This is the fastest way to detect if there are individual point
             // dataLabels that need to be considered in drawDataLabels. These
             // can only occur in object configs.
             if (options.dataLabels) {
                 series._hasPointLabels = true;
             }
-
             // Same approach as above for markers
             if (options.marker) {
                 series._hasPointMarkers = true;
@@ -379,7 +327,6 @@ Highcharts.Point.prototype = {
         }
         return ret;
     },
-
     /**
      * Get the CSS class names for individual points. Used internally where the
      * returned value is set on every point.
@@ -400,7 +347,6 @@ Highcharts.Point.prototype = {
             (this.zone && this.zone.className ? ' ' +
                 this.zone.className.replace('highcharts-negative', '') : '');
     },
-
     /**
      * In a series with `zones`, return the zone that the point belongs to.
      *
@@ -410,86 +356,66 @@ Highcharts.Point.prototype = {
      *         The zone item.
      */
     getZone: function () {
-        var series = this.series,
-            zones = series.zones,
-            zoneAxis = series.zoneAxis || 'y',
-            i = 0,
-            zone;
-
+        var series = this.series, zones = series.zones, zoneAxis = series.zoneAxis || 'y', i = 0, zone;
         zone = zones[i];
         while (this[zoneAxis] >= zone.value) {
             zone = zones[++i];
         }
-
         // For resetting or reusing the point (#8100)
         if (!this.nonZonedColor) {
             this.nonZonedColor = this.color;
         }
-
         if (zone && zone.color && !this.options.color) {
             this.color = zone.color;
-        } else {
+        }
+        else {
             this.color = this.nonZonedColor;
         }
-
         return zone;
     },
-
     /**
      * Destroy a point to clear memory. Its reference still stays in
      * `series.data`.
      *
      * @private
      * @function Highcharts.Point#destroy
+     * @return {void}
      */
     destroy: function () {
-        var point = this,
-            series = point.series,
-            chart = series.chart,
-            hoverPoints = chart.hoverPoints,
-            prop;
-
+        var point = this, series = point.series, chart = series.chart, hoverPoints = chart.hoverPoints, prop;
         chart.pointCount--;
-
         if (hoverPoints) {
             point.setState();
             erase(hoverPoints, point);
             if (!hoverPoints.length) {
                 chart.hoverPoints = null;
             }
-
         }
         if (point === chart.hoverPoint) {
             point.onMouseOut();
         }
-
         // Remove all events and elements
         if (point.graphic || point.dataLabel || point.dataLabels) {
             removeEvent(point);
             point.destroyElements();
         }
-
         if (point.legendItem) { // pies have legend items
             chart.legend.destroyItem(point);
         }
-
-        for (prop in point) {
+        for (prop in point) { // eslint-disable-line guard-for-in
             point[prop] = null;
         }
     },
-
     /**
      * Destroy SVG elements associated with the point.
      *
      * @private
      * @function Highcharts.Point#destroyElements
+     * @param {Highcharts.Dictionary<number>} [kinds]
+     * @return {void}
      */
     destroyElements: function (kinds) {
-        var point = this,
-            props = [],
-            prop,
-            i;
-
+        var point = this, props = [], prop, i;
         kinds = kinds || { graphic: 1, dataLabel: 1 };
         if (kinds.graphic) {
             props.push('graphic', 'shadowGroup');
@@ -497,7 +423,6 @@ Highcharts.Point.prototype = {
         if (kinds.dataLabel) {
             props.push('dataLabel', 'dataLabelUpper', 'connector');
         }
-
         i = props.length;
         while (i--) {
             prop = props[i];
@@ -505,7 +430,6 @@ Highcharts.Point.prototype = {
                 point[prop] = point[prop].destroy();
             }
         }
-
         ['dataLabel', 'connector'].forEach(function (prop) {
             var plural = prop + 's';
             if (kinds[prop] && point[plural]) {
@@ -518,7 +442,6 @@ Highcharts.Point.prototype = {
             }
         });
     },
-
     /**
      * Return the configuration hash needed for the data label and tooltip
      * formatters.
@@ -541,7 +464,6 @@ Highcharts.Point.prototype = {
             total: this.total || this.stackTotal
         };
     },
-
     /**
      * Extendable method for formatting each point's tooltip line.
      *
@@ -554,41 +476,26 @@ Highcharts.Point.prototype = {
      *         A string to be concatenated in to the common tooltip text.
      */
     tooltipFormatter: function (pointFormat) {
-
         // Insert options for valueDecimals, valuePrefix, and valueSuffix
-        var series = this.series,
-            seriesTooltipOptions = series.tooltipOptions,
-            valueDecimals = pick(seriesTooltipOptions.valueDecimals, ''),
-            valuePrefix = seriesTooltipOptions.valuePrefix || '',
-            valueSuffix = seriesTooltipOptions.valueSuffix || '';
-
+        var series = this.series, seriesTooltipOptions = series.tooltipOptions, valueDecimals = pick(seriesTooltipOptions.valueDecimals, ''), valuePrefix = seriesTooltipOptions.valuePrefix || '', valueSuffix = seriesTooltipOptions.valueSuffix || '';
         // Replace default point style with class name
         if (series.chart.styledMode) {
             pointFormat = series.chart.tooltip.styledModeFormat(pointFormat);
         }
-
         // Loop over the point array map and replace unformatted values with
         // sprintf formatting markup
         (series.pointArrayMap || ['y']).forEach(function (key) {
             key = '{point.' + key; // without the closing bracket
             if (valuePrefix || valueSuffix) {
-                pointFormat = pointFormat.replace(
-                    RegExp(key + '}', 'g'),
-                    valuePrefix + key + '}' + valueSuffix
-                );
+                pointFormat = pointFormat.replace(RegExp(key + '}', 'g'), valuePrefix + key + '}' + valueSuffix);
             }
-            pointFormat = pointFormat.replace(
-                RegExp(key + '}', 'g'),
-                key + ':,.' + valueDecimals + 'f}'
-            );
+            pointFormat = pointFormat.replace(RegExp(key + '}', 'g'), key + ':,.' + valueDecimals + 'f}');
         });
-
         return format(pointFormat, {
             point: this,
             series: this.series
         }, series.chart.time);
     },
-
     /**
      * Fire an event on the Point object.
      *
@@ -598,48 +505,35 @@ Highcharts.Point.prototype = {
      * @param {string} eventType
      *        Type of the event.
      *
-     * @param {object} eventArgs
+     * @param {Highcharts.Dictionary<any>|Event} eventArgs
      *        Additional event arguments.
      *
-     * @param {Function} defaultFunction
+     * @param {Highcharts.EventCallbackFunction<Highcharts.Point>|Function} defaultFunction
      *        Default event handler.
      *
      * @fires Highcharts.Point#event:*
      */
     firePointEvent: function (eventType, eventArgs, defaultFunction) {
-        var point = this,
-            series = this.series,
-            seriesOptions = series.options;
-
+        var point = this, series = this.series, seriesOptions = series.options;
         // load event handlers on demand to save time on mouseover/out
-        if (
-            seriesOptions.point.events[eventType] ||
-            (
-                point.options &&
+        if (seriesOptions.point.events[eventType] ||
+            (point.options &&
                 point.options.events &&
-                point.options.events[eventType]
-            )
-        ) {
+                point.options.events[eventType])) {
             this.importEvents();
         }
-
         // add default handler if in selection mode
         if (eventType === 'click' && seriesOptions.allowPointSelect) {
             defaultFunction = function (event) {
                 // Control key is for Windows, meta (= Cmd key) for Mac, Shift
                 // for Opera.
                 if (point.select) { // #2911
-                    point.select(
-                        null,
-                        event.ctrlKey || event.metaKey || event.shiftKey
-                    );
+                    point.select(null, event.ctrlKey || event.metaKey || event.shiftKey);
                 }
             };
         }
-
         fireEvent(this, eventType, eventArgs, defaultFunction);
     },
-
     /**
      * For categorized axes this property holds the category name for the
      * point. For other axes it holds the X value.
@@ -647,7 +541,6 @@ Highcharts.Point.prototype = {
      * @name Highcharts.Point#category
      * @type {number|string}
      */
-
     /**
      * The name of the point. The name can be given as the first position of the
      * point configuration array, or as a `name` property in the configuration:
@@ -671,14 +564,12 @@ Highcharts.Point.prototype = {
      * @name Highcharts.Point#name
      * @type {string}
      */
-
     /**
      * The percentage for points in a stacked series or pies.
      *
      * @name Highcharts.Point#percentage
      * @type {number}
      */
-
     /**
      * The total of values in either a stack for stacked series, or a pie in a
      * pie series.
@@ -686,7 +577,6 @@ Highcharts.Point.prototype = {
      * @name Highcharts.Point#total
      * @type {number}
      */
-
     /**
      * For certain series types, like pie charts, where individual points can
      * be shown or hidden.