highcharts 8.1.0 → 8.2.2

package/es-modules/{parts → Core/Series}/Point.js

@@ -8,7 +8,11 @@
  *
  * */
 'use strict';
-import Highcharts from './Globals.js';
+import A from '../Animation/AnimationUtilities.js';
+var animObject = A.animObject;
+import H from '../Globals.js';
+import U from '../Utilities.js';
+var defined = U.defined, erase = U.erase, extend = U.extend, fireEvent = U.fireEvent, format = U.format, getNestedProperty = U.getNestedProperty, isArray = U.isArray, isNumber = U.isNumber, isObject = U.isObject, syncTimeout = U.syncTimeout, pick = U.pick, removeEvent = U.removeEvent, uniqueKey = U.uniqueKey;
 /**
  * Function callback when a series point is clicked. Return false to cancel the
  * action.
@@ -113,9 +117,9 @@ import Highcharts from './Globals.js';
  * @interface Highcharts.PointOptionsObject
  */
 /**
- * Possible option types for a data point.
+ * Possible option types for a data point. Use `null` to indicate a gap.
  *
- * @typedef {number|string|Array<(number|string)>|Highcharts.PointOptionsObject|null} Highcharts.PointOptionsType
+ * @typedef {number|string|Highcharts.PointOptionsObject|Array<(number|string|null)>|null} Highcharts.PointOptionsType
  */
 /**
  * Gets fired when the point is removed using the `.remove()` method.
@@ -156,9 +160,6 @@ import Highcharts from './Globals.js';
 * @type {Highcharts.PointOptionsType}
 */
 ''; // detach doclet above
-import U from './Utilities.js';
-var animObject = U.animObject, defined = U.defined, erase = U.erase, extend = U.extend, fireEvent = U.fireEvent, format = U.format, getNestedProperty = U.getNestedProperty, isArray = U.isArray, isNumber = U.isNumber, isObject = U.isObject, syncTimeout = U.syncTimeout, pick = U.pick, removeEvent = U.removeEvent, uniqueKey = U.uniqueKey;
-var H = Highcharts;
 /* eslint-disable no-invalid-this, valid-jsdoc */
 /**
  * The Point object. The point objects are generated from the `series.data`
@@ -280,7 +281,6 @@ var Point = /** @class */ (function () {
      *
      * @private
      * @function Highcharts.Point#animateBeforeDestroy
-     * @return {void}
      */
     Point.prototype.animateBeforeDestroy = function () {
         var point = this, animateParams = { x: point.startXPos, opacity: 0 }, isDataLabel, graphicalProps = point.getGraphicalProps();
@@ -379,7 +379,6 @@ var Point = /** @class */ (function () {
      *
      * @private
      * @function Highcharts.Point#destroy
-     * @return {void}
      */
     Point.prototype.destroy = function () {
         var point = this, series = point.series, chart = series.chart, dataSorting = series.options.dataSorting, hoverPoints = chart.hoverPoints, globalAnimation = point.series.chart.renderer.globalAnimation, animation = animObject(globalAnimation), prop;
@@ -426,7 +425,6 @@ var Point = /** @class */ (function () {
      * @private
      * @function Highcharts.Point#destroyElements
      * @param {Highcharts.Dictionary<number>} [kinds]
-     * @return {void}
      */
     Point.prototype.destroyElements = function (kinds) {
         var point = this, props = point.getGraphicalProps(kinds);
@@ -803,4 +801,4 @@ var Point = /** @class */ (function () {
     return Point;
 }());
 H.Point = Point;
-export default H.Point;
+export default Point;

package/es-modules/Core/Series/Series.js

@@ -0,0 +1,158 @@
+/* *
+ *
+ *  (c) 2010-2020 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+import H from '../Globals.js';
+import Point from './Point.js';
+import U from '../Utilities.js';
+var error = U.error, extendClass = U.extendClass, fireEvent = U.fireEvent, getOptions = U.getOptions, isObject = U.isObject, merge = U.merge, objectEach = U.objectEach;
+import '../Options.js';
+/**
+ * @class
+ * @name Highcharts.Series
+ */
+var BaseSeries = /** @class */ (function () {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    function BaseSeries(chart, options) {
+        var mergedOptions = merge(BaseSeries.defaultOptions, options);
+        this.chart = chart;
+        this._i = chart.series.length;
+        chart.series.push(this);
+        this.options = mergedOptions;
+        this.userOptions = merge(options);
+    }
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
+    BaseSeries.addSeries = function (seriesName, seriesType) {
+        BaseSeries.seriesTypes[seriesName] = seriesType;
+    };
+    BaseSeries.cleanRecursively = function (toClean, reference) {
+        var clean = {};
+        objectEach(toClean, function (_val, key) {
+            var ob;
+            // Dive into objects (except DOM nodes)
+            if (isObject(toClean[key], true) &&
+                !toClean.nodeType && // #10044
+                reference[key]) {
+                ob = BaseSeries.cleanRecursively(toClean[key], reference[key]);
+                if (Object.keys(ob).length) {
+                    clean[key] = ob;
+                }
+                // Arrays, primitives and DOM nodes are copied directly
+            }
+            else if (isObject(toClean[key]) ||
+                toClean[key] !== reference[key]) {
+                clean[key] = toClean[key];
+            }
+        });
+        return clean;
+    };
+    // eslint-disable-next-line valid-jsdoc
+    /**
+     * Internal function to initialize an individual series.
+     * @private
+     */
+    BaseSeries.getSeries = function (chart, options) {
+        if (options === void 0) { options = {}; }
+        var optionsChart = chart.options.chart, type = (options.type ||
+            optionsChart.type ||
+            optionsChart.defaultSeriesType ||
+            ''), Series = BaseSeries.seriesTypes[type];
+        // No such series type
+        if (!Series) {
+            error(17, true, chart, { missingModuleFor: type });
+        }
+        return new Series(chart, options);
+    };
+    /**
+     * Factory to create new series prototypes.
+     *
+     * @function Highcharts.seriesType
+     *
+     * @param {string} type
+     * The series type name.
+     *
+     * @param {string} parent
+     * The parent series type name. Use `line` to inherit from the basic
+     * {@link Series} object.
+     *
+     * @param {Highcharts.SeriesOptionsType|Highcharts.Dictionary<*>} options
+     * The additional default options that are merged with the parent's options.
+     *
+     * @param {Highcharts.Dictionary<*>} [props]
+     * The properties (functions and primitives) to set on the new prototype.
+     *
+     * @param {Highcharts.Dictionary<*>} [pointProps]
+     * Members for a series-specific extension of the {@link Point} prototype if
+     * needed.
+     *
+     * @return {Highcharts.Series}
+     * The newly created prototype as extended from {@link Series} or its
+     * derivatives.
+     */
+    // docs: add to API + extending Highcharts
+    BaseSeries.seriesType = function (type, parent, options, seriesProto, pointProto) {
+        var defaultOptions = getOptions().plotOptions || {}, seriesTypes = BaseSeries.seriesTypes;
+        parent = parent || '';
+        // Merge the options
+        defaultOptions[type] = merge(defaultOptions[parent], options);
+        // Create the class
+        BaseSeries.addSeries(type, extendClass(seriesTypes[parent] || function () { }, seriesProto));
+        seriesTypes[type].prototype.type = type;
+        // Create the point class if needed
+        if (pointProto) {
+            seriesTypes[type].prototype.pointClass =
+                extendClass(Point, pointProto);
+        }
+        return seriesTypes[type];
+    };
+    BaseSeries.prototype.update = function (newOptions, redraw) {
+        if (redraw === void 0) { redraw = true; }
+        var series = this;
+        newOptions = BaseSeries.cleanRecursively(newOptions, this.userOptions);
+        var newType = newOptions.type;
+        if (typeof newType !== 'undefined' &&
+            newType !== series.type) {
+            series = BaseSeries.getSeries(series.chart, newOptions);
+        }
+        fireEvent(series, 'update', { newOptions: newOptions });
+        series.userOptions = merge(newOptions);
+        fireEvent(series, 'afterUpdate', { newOptions: newOptions });
+        if (redraw) {
+            series.chart.redraw();
+        }
+        return series;
+    };
+    /* *
+     *
+     *  Static Properties
+     *
+     * */
+    BaseSeries.defaultOptions = {
+        type: 'base'
+    };
+    BaseSeries.seriesTypes = {};
+    return BaseSeries;
+}());
+BaseSeries.prototype.pointClass = Point;
+// backwards compatibility
+H.seriesType = BaseSeries.seriesType;
+H.seriesTypes = BaseSeries.seriesTypes;
+/* *
+ *
+ *  Export
+ *
+ * */
+export default BaseSeries;

package/es-modules/{parts-3d/Series.js → Core/Series/Series3D.js}

@@ -10,10 +10,12 @@
  *
  * */
 'use strict';
-import H from '../parts/Globals.js';
-import U from '../parts/Utilities.js';
+import H from '../Globals.js';
+import Math3D from '../../Extensions/Math3D.js';
+var perspective = Math3D.perspective;
+import U from '../Utilities.js';
 var addEvent = U.addEvent, pick = U.pick;
-var perspective = H.perspective;
+import '../../Series/LineSeries.js';
 /* eslint-disable no-invalid-this */
 // Wrap the translate method to post-translate points into 3D perspective
 addEvent(H.Series, 'afterTranslate', function () {

package/es-modules/{parts → Core}/Time.js

@@ -71,6 +71,16 @@ import Highcharts from './Globals.js';
  * @return {number}
  * Timezone offset in minutes.
  */
+/**
+ * Allows to manually load the `moment.js` library from Highcharts options
+ * instead of the `window`.
+ * In case of loading the library from a `script` tag,
+ * this option is not needed, it will be loaded from there by default.
+ *
+ * @type {function}
+ * @since 8.2.0
+ * @apioption time.moment
+ */
 import U from './Utilities.js';
 var defined = U.defined, error = U.error, extend = U.extend, isObject = U.isObject, merge = U.merge, objectEach = U.objectEach, pad = U.pad, pick = U.pick, splat = U.splat, timeUnits = U.timeUnits;
 var H = Highcharts, win = H.win;
@@ -326,7 +336,7 @@ var Time = /** @class */ (function () {
      *         A getTimezoneOffset function
      */
     Time.prototype.timezoneOffsetFunction = function () {
-        var time = this, options = this.options, moment = win.moment;
+        var time = this, options = this.options, moment = options.moment || win.moment;
         if (!this.useUTC) {
             return function (timestamp) {
                 return new Date(timestamp.toString()).getTimezoneOffset() * 60000;
@@ -640,138 +650,6 @@ var Time = /** @class */ (function () {
         });
         return tickPositions;
     };
-    /* *
-     *
-     *  Static Properties
-     *
-     * */
-    /**
-     * Time options that can apply globally or to individual charts. These
-     * settings affect how `datetime` axes are laid out, how tooltips are
-     * formatted, how series
-     * [pointIntervalUnit](#plotOptions.series.pointIntervalUnit) works and how
-     * the Highstock range selector handles time.
-     *
-     * The common use case is that all charts in the same Highcharts object
-     * share the same time settings, in which case the global settings are set
-     * using `setOptions`.
-     *
-     * ```js
-     * // Apply time settings globally
-     * Highcharts.setOptions({
-     *     time: {
-     *         timezone: 'Europe/London'
-     *     }
-     * });
-     * // Apply time settings by instance
-     * var chart = Highcharts.chart('container', {
-     *     time: {
-     *         timezone: 'America/New_York'
-     *     },
-     *     series: [{
-     *         data: [1, 4, 3, 5]
-     *     }]
-     * });
-     *
-     * // Use the Time object
-     * console.log(
-     *        'Current time in New York',
-     *        chart.time.dateFormat('%Y-%m-%d %H:%M:%S', Date.now())
-     * );
-     * ```
-     *
-     * Since v6.0.5, the time options were moved from the `global` obect to the
-     * `time` object, and time options can be set on each individual chart.
-     *
-     * @sample {highcharts|highstock}
-     *         highcharts/time/timezone/
-     *         Set the timezone globally
-     * @sample {highcharts}
-     *         highcharts/time/individual/
-     *         Set the timezone per chart instance
-     * @sample {highstock}
-     *         stock/time/individual/
-     *         Set the timezone per chart instance
-     *
-     * @since     6.0.5
-     * @optionparent time
-     */
-    Time.defaultOptions = {
-        /**
-         * A custom `Date` class for advanced date handling. For example,
-         * [JDate](https://github.com/tahajahangir/jdate) can be hooked in to
-         * handle Jalali dates.
-         *
-         * @type      {*}
-         * @since     4.0.4
-         * @product   highcharts highstock gantt
-         */
-        Date: void 0,
-        /**
-         * A callback to return the time zone offset for a given datetime. It
-         * takes the timestamp in terms of milliseconds since January 1 1970,
-         * and returns the timezone offset in minutes. This provides a hook
-         * for drawing time based charts in specific time zones using their
-         * local DST crossover dates, with the help of external libraries.
-         *
-         * @see [global.timezoneOffset](#global.timezoneOffset)
-         *
-         * @sample {highcharts|highstock} highcharts/time/gettimezoneoffset/
-         *         Use moment.js to draw Oslo time regardless of browser locale
-         *
-         * @type      {Highcharts.TimezoneOffsetCallbackFunction}
-         * @since     4.1.0
-         * @product   highcharts highstock gantt
-         */
-        getTimezoneOffset: void 0,
-        /**
-         * Requires [moment.js](https://momentjs.com/). If the timezone option
-         * is specified, it creates a default
-         * [getTimezoneOffset](#time.getTimezoneOffset) function that looks
-         * up the specified timezone in moment.js. If moment.js is not included,
-         * this throws a Highcharts error in the console, but does not crash the
-         * chart.
-         *
-         * @see [getTimezoneOffset](#time.getTimezoneOffset)
-         *
-         * @sample {highcharts|highstock} highcharts/time/timezone/
-         *         Europe/Oslo
-         *
-         * @type      {string}
-         * @since     5.0.7
-         * @product   highcharts highstock gantt
-         */
-        timezone: void 0,
-        /**
-         * The timezone offset in minutes. Positive values are west, negative
-         * values are east of UTC, as in the ECMAScript
-         * [getTimezoneOffset](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset)
-         * method. Use this to display UTC based data in a predefined time zone.
-         *
-         * @see [time.getTimezoneOffset](#time.getTimezoneOffset)
-         *
-         * @sample {highcharts|highstock} highcharts/time/timezoneoffset/
-         *         Timezone offset
-         *
-         * @since     3.0.8
-         * @product   highcharts highstock gantt
-         */
-        timezoneOffset: 0,
-        /**
-         * Whether to use UTC time for axis scaling, tickmark placement and
-         * time display in `Highcharts.dateFormat`. Advantages of using UTC
-         * is that the time displays equally regardless of the user agent's
-         * time zone settings. Local time can be used when the data is loaded
-         * in real time or when correct Daylight Saving Time transitions are
-         * required.
-         *
-         * @sample {highcharts} highcharts/time/useutc-true/
-         *         True by default
-         * @sample {highcharts} highcharts/time/useutc-false/
-         *         False
-         */
-        useUTC: true
-    };
     return Time;
 }());
 H.Time = Time;

package/es-modules/{parts → Core}/Tooltip.js

@@ -9,8 +9,9 @@
  * */
 'use strict';
 import H from './Globals.js';
+var doc = H.doc;
 import U from './Utilities.js';
-var clamp = U.clamp, css = U.css, defined = U.defined, discardElement = U.discardElement, extend = U.extend, fireEvent = U.fireEvent, format = U.format, isNumber = U.isNumber, isString = U.isString, merge = U.merge, offset = U.offset, pick = U.pick, splat = U.splat, syncTimeout = U.syncTimeout, timeUnits = U.timeUnits;
+var clamp = U.clamp, css = U.css, defined = U.defined, discardElement = U.discardElement, extend = U.extend, fireEvent = U.fireEvent, format = U.format, isNumber = U.isNumber, isString = U.isString, merge = U.merge, pick = U.pick, splat = U.splat, syncTimeout = U.syncTimeout, timeUnits = U.timeUnits;
 /**
  * Callback function to format the text of the tooltip from scratch.
  *
@@ -68,22 +69,26 @@ var clamp = U.clamp, css = U.css, defined = U.defined, discardElement = U.discar
  *
  * @callback Highcharts.TooltipPositionerCallbackFunction
  *
+ * @param {Highcharts.Tooltip} this
+ * Tooltip context of the callback.
+ *
  * @param {number} labelWidth
- *        Width of the tooltip.
+ * Width of the tooltip.
  *
  * @param {number} labelHeight
- *        Height of the tooltip.
+ * Height of the tooltip.
  *
- * @param {Highcharts.Point} point
- *        Point information for positioning a tooltip.
+ * @param {Highcharts.TooltipPositionerPointObject} point
+ * Point information for positioning a tooltip.
  *
  * @return {Highcharts.PositionObject}
- *         New position for the tooltip.
+ * New position for the tooltip.
  */
 /**
  * Point information for positioning a tooltip.
  *
  * @interface Highcharts.TooltipPositionerPointObject
+ * @extends Highcharts.Point
  */ /**
 * If `tooltip.split` option is enabled and positioner is called for each of the
 * boxes separately, this property indicates the call on the xAxis header, which
@@ -91,9 +96,6 @@ var clamp = U.clamp, css = U.css, defined = U.defined, discardElement = U.discar
 * @name Highcharts.TooltipPositionerPointObject#isHeader
 * @type {boolean}
 */ /**
-* @name Highcharts.TooltipPositionerPointObject#negative
-* @type {boolean}
-*/ /**
 * The reference point relative to the plot area. Add chart.plotLeft to get the
 * full coordinates.
 * @name Highcharts.TooltipPositionerPointObject#plotX
@@ -108,7 +110,6 @@ var clamp = U.clamp, css = U.css, defined = U.defined, discardElement = U.discar
  * @typedef {"callout"|"circle"|"square"} Highcharts.TooltipShapeValue
  */
 ''; // separates doclets above from variables below
-var doc = H.doc;
 /* eslint-disable no-invalid-this, valid-jsdoc */
 /**
  * Tooltip of a chart.
@@ -129,6 +130,7 @@ var Tooltip = /** @class */ (function () {
      *
      * */
     function Tooltip(chart, options) {
+        this.container = void 0;
         this.crosshairs = [];
         this.distance = 0;
         this.isHidden = true;
@@ -468,16 +470,14 @@ var Tooltip = /** @class */ (function () {
             // Split tooltip use updateTooltipContainer to position the tooltip
             // container.
             if (tooltip.outside && !tooltip.split) {
-                set = {
-                    x: this.label.xSetter,
-                    y: this.label.ySetter
-                };
-                this.label.xSetter = function (value, key) {
-                    set[key].call(this.label, tooltip.distance);
+                var label_1 = this.label;
+                var xSetter_1 = label_1.xSetter, ySetter_1 = label_1.ySetter;
+                label_1.xSetter = function (value) {
+                    xSetter_1.call(label_1, tooltip.distance);
                     container.style.left = value + 'px';
                 };
-                this.label.ySetter = function (value, key) {
-                    set[key].call(this.label, tooltip.distance);
+                label_1.ySetter = function (value) {
+                    ySetter_1.call(label_1, tooltip.distance);
                     container.style.top = value + 'px';
                 };
             }
@@ -1075,14 +1075,15 @@ var Tooltip = /** @class */ (function () {
         // Create the individual labels for header and points, ignore footer
         var boxes = labels.slice(0, points.length + 1).reduce(function (boxes, str, i) {
             if (str !== false && str !== '') {
-                var point = points[i - 1] || {
-                    // Item 0 is the header. Instead of this, we could also
-                    // use the crosshair label
-                    isHeader: true,
-                    plotX: points[0].plotX,
-                    plotY: plotHeight,
-                    series: {}
-                };
+                var point = (points[i - 1] ||
+                    {
+                        // Item 0 is the header. Instead of this, we could also
+                        // use the crosshair label
+                        isHeader: true,
+                        plotX: points[0].plotX,
+                        plotY: plotHeight,
+                        series: {}
+                    });
                 var isHeader = point.isHeader;
                 // Store the tooltip label referance on the series
                 var owner = isHeader ? tooltip : point.series;
@@ -1101,7 +1102,9 @@ var Tooltip = /** @class */ (function () {
                 var _a = getAnchor(point), anchorX = _a.anchorX, anchorY = _a.anchorY;
                 if (typeof anchorY === 'number') {
                     var size = bBox.height + 1;
-                    var boxPosition = positioner ? positioner.call(tooltip, boxWidth, size, point) : defaultPositioner(anchorX, anchorY, isHeader, boxWidth);
+                    var boxPosition = (positioner ?
+                        positioner.call(tooltip, boxWidth, size, point) :
+                        defaultPositioner(anchorX, anchorY, isHeader, boxWidth));
                     boxes.push({
                         // 0-align to the top, 1-align to the bottom
                         align: positioner ? 0 : void 0,