highcharts 9.3.1 → 10.0.0

package/es-modules/Core/Chart/Chart3D.js

@@ -320,12 +320,22 @@ var Chart3D;
             else {
                 ret.axes = {
                     y: {
-                        'left': { x: xm, z: zm, xDir: { x: 1, y: 0, z: 0 } },
-                        'right': { x: xp, z: zm, xDir: { x: 0, y: 0, z: 1 } }
+                        'left': {
+                            x: xm, z: zm, xDir: { x: 1, y: 0, z: 0 }
+                        },
+                        'right': {
+                            x: xp, z: zm, xDir: { x: 0, y: 0, z: 1 }
+                        }
                     },
                     x: {
-                        'top': { y: ym, z: zm, xDir: { x: 1, y: 0, z: 0 } },
-                        'bottom': { y: yp, z: zm, xDir: { x: 1, y: 0, z: 0 } }
+                        'top': {
+                            y: ym, z: zm, xDir: { x: 1, y: 0, z: 0 }
+                        },
+                        'bottom': {
+                            y: yp,
+                            z: zm,
+                            xDir: { x: 1, y: 0, z: 0 }
+                        }
                     },
                     z: {
                         'top': {
@@ -351,7 +361,7 @@ var Chart3D;
          * Calculate scale of the 3D view. That is required to fit chart's 3D
          * projection into the actual plotting area. Reported as #4933.
          *
-         * @notice
+         * **Note:**
          * This function should ideally take the plot values instead of a chart
          * object, but since the chart object is needed for perspective it is
          * not practical. Possible to make both getScale and perspective more
@@ -640,7 +650,8 @@ var Chart3D;
             var interpolated;
             if (this.pos < 1 &&
                 (isArray(this.start) || isArray(this.end))) {
-                var start = this.start || [1, 0, 0, 1, 0, 0], end = this.end || [1, 0, 0, 1, 0, 0];
+                var start = (this.start ||
+                    [1, 0, 0, 1, 0, 0]), end = this.end || [1, 0, 0, 1, 0, 0];
                 interpolated = [];
                 for (var i = 0; i < 6; i++) {
                     interpolated.push(this.pos * end[i] + (1 - this.pos) * start[i]);
@@ -1483,17 +1494,7 @@ var Chart3D;
      */
     function onAfterGetContainer() {
         if (this.styledMode) {
-            this.renderer.definition({
-                tagName: 'style',
-                textContent: '.highcharts-3d-top{' +
-                    'filter: url(#highcharts-brighter)' +
-                    '}\n' +
-                    '.highcharts-3d-side{' +
-                    'filter: url(#highcharts-darker)' +
-                    '}\n'
-            });
-            // Add add definitions used by brighter and darker faces of the
-            // cuboids.
+            // Add definitions used by brighter and darker faces of the cuboids.
             [{
                     name: 'darker',
                     slope: 0.6
@@ -1559,14 +1560,16 @@ var Chart3D;
             chart.is3d()) {
             // Add a 0-360 normalisation for alfa and beta angles in 3d graph
             if (options3d) {
-                options3d.alpha = options3d.alpha % 360 + (options3d.alpha >= 0 ? 0 : 360);
-                options3d.beta = options3d.beta % 360 + (options3d.beta >= 0 ? 0 : 360);
+                options3d.alpha = options3d.alpha % 360 +
+                    (options3d.alpha >= 0 ? 0 : 360);
+                options3d.beta = options3d.beta % 360 +
+                    (options3d.beta >= 0 ? 0 : 360);
             }
             var inverted = chart.inverted, clipBox = chart.clipBox, margin = chart.margin, x = inverted ? 'y' : 'x', y = inverted ? 'x' : 'y', w = inverted ? 'height' : 'width', h = inverted ? 'width' : 'height';
             clipBox[x] = -(margin[3] || 0);
             clipBox[y] = -(margin[0] || 0);
-            clipBox[w] = chart.chartWidth + (margin[3] || 0) + (margin[1] || 0);
-            clipBox[h] = chart.chartHeight + (margin[0] || 0) + (margin[2] || 0);
+            clipBox[w] = (chart.chartWidth + (margin[3] || 0) + (margin[1] || 0));
+            clipBox[h] = (chart.chartHeight + (margin[0] || 0) + (margin[2] || 0));
             // Set scale, used later in perspective method():
             // getScale uses perspective, so scale3d has to be reset.
             chart.scale3d = 1;

package/es-modules/Core/Chart/ChartDefaults.js

@@ -20,18 +20,19 @@
  */
 var ChartDefaults = {
     /**
-     * Default `mapData` for all series. If set to a string, it functions
-     * as an index into the `Highcharts.maps` array. Otherwise it is
-     * interpreted as map data.
+     * Default `mapData` for all series, in terms of a GeoJSON or TopoJSON
+     * object. If set to a string, it functions as an index into the
+     * `Highcharts.maps` array.
      *
-     * @see [mapData](#series.map.mapData)
+     * For picking out individual shapes and geometries to use for each series
+     * of the map, see [series.mapData](#series.map.mapData).
      *
      * @sample    maps/demo/geojson
-     *            Loading geoJSON data
+     *            Loading GeoJSON data
      * @sample    maps/chart/topojson
-     *            Loading topoJSON converted to geoJSON
+     *            Loading TopoJSON data
      *
-     * @type      {string|Array<*>|Highcharts.GeoJSON}
+     * @type      {string|Array<*>|Highcharts.GeoJSON|Highcharts.TopoJSON}
      * @since     5.0.0
      * @product   highmaps
      * @apioption chart.map
@@ -46,7 +47,7 @@ var ChartDefaults = {
      * @apioption chart.mapTransforms
      */
     /**
-     * When using multiple axis, the ticks of two or more opposite axes
+     * When using multiple axes, the ticks of two or more opposite axes
      * will automatically be aligned by adding ticks to the axis or axes
      * with the least ticks, as if `tickAmount` were specified.
      *
@@ -54,8 +55,8 @@ var ChartDefaults = {
      * lines look messy, it's a good idea to hide them for the secondary
      * axis by setting `gridLineWidth` to 0.
      *
-     * If `startOnTick` or `endOnTick` in an Axis options are set to false,
-     * then the `alignTicks ` will be disabled for the Axis.
+     * If `startOnTick` or `endOnTick` in the axis options are set to false,
+     * then the `alignTicks ` will be disabled for the axis.
      *
      * Disabled for logarithmic axes.
      *
@@ -73,6 +74,25 @@ var ChartDefaults = {
      * @product   highcharts highstock gantt
      * @apioption chart.alignTicks
      */
+    /**
+     * When using multiple axes, align the thresholds. When this is true, other
+     * ticks will also be aligned.
+     *
+     * Note that for line series and some other series types, the `threshold`
+     * option is set to `null` by default. This will in turn cause their y-axis
+     * to not have a threshold. In order to avoid that, set the series
+     * `threshold` to 0 or another number.
+     *
+     * If `startOnTick` or `endOnTick` in the axis options are set to false, or
+     * if the axis is logarithmic, the threshold will not be aligned.
+     *
+     * @sample {highcharts} highcharts/chart/alignthresholds/ Set to true
+     *
+     * @since 10.0.0
+     * @product   highcharts highstock gantt
+     * @apioption chart.alignThresholds
+     */
+    alignThresholds: false,
     /**
      * Set the overall animation for all chart updating. Animation can be
      * disabled throughout the chart by setting it to false here. It can
@@ -876,9 +896,10 @@ var ChartDefaults = {
      *         Y
      * @sample {highstock} stock/chart/zoomtype-xy/
      *         Xy
+     * @sample {highmaps} maps/chart/zoomtype-xy/
+     *         Map with selection zoom
      *
      * @type       {string}
-     * @product    highcharts highstock gantt
      * @validvalue ["x", "y", "xy"]
      * @apioption  chart.zoomType
      */

package/es-modules/Core/Chart/GanttChart.js

@@ -61,10 +61,9 @@ var GanttChart = /** @class */ (function (_super) {
      *        Function to run when the chart has loaded and and all external
      *        images are loaded.
      *
-     * @return {void}
      *
-     * @fires Highcharts.GanttChart#event:init
-     * @fires Highcharts.GanttChart#event:afterInit
+     * @emits Highcharts.GanttChart#event:init
+     * @emits Highcharts.GanttChart#event:afterInit
      */
     GanttChart.prototype.init = function (userOptions, callback) {
         var defaultOptions = getOptions(), xAxisOptions = userOptions.xAxis, yAxisOptions = userOptions.yAxis;
@@ -126,7 +125,8 @@ var GanttChart = /** @class */ (function (_super) {
                 reversed: true,
                 // Set default type treegrid, but only if 'categories' is
                 // undefined
-                type: yAxisOptions.categories ? yAxisOptions.type : 'treegrid'
+                type: yAxisOptions.categories ?
+                    yAxisOptions.type : 'treegrid'
             }, yAxisOptions // user options
             );
         });

package/es-modules/Core/Chart/MapChart.js

@@ -24,10 +24,9 @@ var __extends = (this && this.__extends) || (function () {
 import Chart from './Chart.js';
 import D from '../DefaultOptions.js';
 var getOptions = D.getOptions;
-import MapView from '../../Maps/MapView.js';
 import SVGRenderer from '../Renderer/SVG/SVGRenderer.js';
 import U from '../Utilities.js';
-var addEvent = U.addEvent, clamp = U.clamp, isNumber = U.isNumber, merge = U.merge, pick = U.pick;
+var merge = U.merge, pick = U.pick;
 import '../../Maps/MapSymbols.js';
 /**
  * Map-optimized chart. Use {@link Highcharts.Chart|Chart} for common charts.
@@ -56,16 +55,11 @@ var MapChart = /** @class */ (function (_super) {
      *        Function to run when the chart has loaded and and all external
      *        images are loaded.
      *
-     * @return {void}
      *
-     * @fires Highcharts.MapChart#event:init
-     * @fires Highcharts.MapChart#event:afterInit
+     * @emits Highcharts.MapChart#event:init
+     * @emits Highcharts.MapChart#event:afterInit
      */
     MapChart.prototype.init = function (userOptions, callback) {
-        // Initialize the MapView after initialization, but before firstRender
-        addEvent(this, 'afterInit', function () {
-            this.mapView = new MapView(this, this.options.mapView);
-        });
         var defaultCreditsOptions = getOptions().credits;
         var options = merge({
             chart: {
@@ -144,6 +138,7 @@ var MapChart = /** @class */ (function (_super) {
      * @param {string|Array<string|number>} path
      *
      * @return {Highcharts.SVGPathArray}
+     * Splitted SVG path
      */
     function splitPath(path) {
         var arr;

package/es-modules/Core/Chart/StockChart.js

@@ -75,10 +75,9 @@ var StockChart = /** @class */ (function (_super) {
      *        Function to run when the chart has loaded and and all external
      *        images are loaded.
      *
-     * @return {void}
      *
-     * @fires Highcharts.StockChart#event:init
-     * @fires Highcharts.StockChart#event:afterInit
+     * @emits Highcharts.StockChart#event:init
+     * @emits Highcharts.StockChart#event:afterInit
      */
     StockChart.prototype.init = function (userOptions, callback) {
         var defaultOptions = getOptions(), xAxisOptions = userOptions.xAxis, yAxisOptions = userOptions.yAxis, 
@@ -100,7 +99,8 @@ var StockChart = /** @class */ (function (_super) {
             },
             scrollbar: {
                 // #4988 - check if setOptions was called
-                enabled: pick(defaultOptions.scrollbar && defaultOptions.scrollbar.enabled, true)
+                enabled: pick((defaultOptions.scrollbar &&
+                    defaultOptions.scrollbar.enabled), true)
             },
             rangeSelector: {
                 // #4988 - check if setOptions was called
@@ -125,15 +125,15 @@ var StockChart = /** @class */ (function (_super) {
         // apply X axis options to both single and multi y axes
         options.xAxis = splat(userOptions.xAxis || {}).map(function (xAxisOptions, i) {
             return merge(getDefaultAxisOptions('xAxis', xAxisOptions), defaultOptions.xAxis, // #3802
-            defaultOptions.xAxis && defaultOptions.xAxis[i], // #7690
-            xAxisOptions, // user options
+            // #7690
+            defaultOptions.xAxis && defaultOptions.xAxis[i], xAxisOptions, // user options
             getForcedAxisOptions('xAxis', userOptions));
         });
         // apply Y axis options to both single and multi y axes
         options.yAxis = splat(userOptions.yAxis || {}).map(function (yAxisOptions, i) {
             return merge(getDefaultAxisOptions('yAxis', yAxisOptions), defaultOptions.yAxis, // #3802
-            defaultOptions.yAxis && defaultOptions.yAxis[i], // #7690
-            yAxisOptions // user options
+            // #7690
+            defaultOptions.yAxis && defaultOptions.yAxis[i], yAxisOptions // user options
             );
         });
         _super.prototype.init.call(this, options, callback);
@@ -144,14 +144,10 @@ var StockChart = /** @class */ (function (_super) {
      *
      * @private
      * @function Highcharts.StockChart#createAxis
-     *
      * @param {string} type
-     *        An axis type.
-     *
+     * An axis type.
      * @param {Chart.CreateAxisOptionsObject} options
-     *        The axis creation options.
-     *
-     * @return {Highcharts.Axis | Highcharts.ColorAxis}
+     * The axis creation options.
      */
     StockChart.prototype.createAxis = function (type, options) {
         options.axis = merge(getDefaultAxisOptions(type, options.axis), options.axis, getForcedAxisOptions(type, this.userOptions));
@@ -207,9 +203,6 @@ var StockChart = /** @class */ (function (_super) {
  *
  * @private
  * @function getDefaultAxisOptions
- * @param {string} type
- * @param {Highcharts.AxisOptions} options
- * @return {Highcharts.AxisOptions}
  */
 function getDefaultAxisOptions(type, options) {
     if (type === 'xAxis') {
@@ -256,9 +249,6 @@ function getDefaultAxisOptions(type, options) {
  *
  * @private
  * @function getForcedAxisOptions
- * @param {string} type
- * @param {Highcharts.Options} chartOptions
- * @return {Highcharts.AxisOptions}
  */
 function getForcedAxisOptions(type, chartOptions) {
     if (type === 'xAxis') {
@@ -453,9 +443,6 @@ addEvent(Axis, 'getPlotLinePath', function (e) {
  *
  * @private
  * @function Highcharts.SVGRenderer#crispPolyLine
- * @param {Highcharts.SVGPathArray} points
- * @param {number} width
- * @return {Highcharts.SVGPathArray}
  */
 SVGRenderer.prototype.crispPolyLine = function (points, width) {
     // points format: [['M', 0, 0], ['L', 100, 0]]

package/es-modules/Core/DefaultOptions.js

@@ -2271,6 +2271,8 @@ var defaultOptions = {
          *
          * @sample {highcharts} highcharts/tooltip/pointformat/
          *         A different point format with value suffix
+         * @sample {highcharts|highstock} highcharts/tooltip/pointformat-extra-information/
+         *         Show extra information about points in the tooltip
          * @sample {highmaps} maps/tooltip/format/
          *         Format demo
          *
@@ -2514,6 +2516,7 @@ var defaultTime = new Time(merge(defaultOptions.global, defaultOptions.time));
  * @function Highcharts.getOptions
  *
  * @return {Highcharts.Options}
+ * Default options.
  */
 function getOptions() {
     return defaultOptions;
@@ -2528,10 +2531,10 @@ function getOptions() {
  * @function Highcharts.setOptions
  *
  * @param {Highcharts.Options} options
- *        The new custom chart options.
+ * The new custom chart options.
  *
  * @return {Highcharts.Options}
- *         Updated options.
+ * Updated options.
  */
 function setOptions(options) {
     // Copy in the default options

package/es-modules/Core/Geometry/CircleUtilities.js

@@ -75,7 +75,8 @@ var CircleUtilities;
      * Returns the area of the circular segment.
      */
     function getCircularSegmentArea(r, h) {
-        return r * r * Math.acos(1 - h / r) - (r - h) * Math.sqrt(h * (2 * r - h));
+        return (r * r * Math.acos(1 - h / r) -
+            (r - h) * Math.sqrt(h * (2 * r - h)));
     }
     CircleUtilities.getCircularSegmentArea = getCircularSegmentArea;
     /**

package/es-modules/Core/Geometry/PolygonClip.js

@@ -0,0 +1,84 @@
+/* *
+ *
+ *  (c) 2010-2021 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+var isInside = function (clipEdge1, clipEdge2, p) {
+    return (clipEdge2[0] - clipEdge1[0]) * (p[1] - clipEdge1[1]) >
+        (clipEdge2[1] - clipEdge1[1]) * (p[0] - clipEdge1[0]);
+};
+var intersection = function (clipEdge1, clipEdge2, prevPoint, currentPoint) {
+    var dc = [
+        clipEdge1[0] - clipEdge2[0],
+        clipEdge1[1] - clipEdge2[1]
+    ], dp = [
+        prevPoint[0] - currentPoint[0],
+        prevPoint[1] - currentPoint[1]
+    ], n1 = clipEdge1[0] * clipEdge2[1] - clipEdge1[1] * clipEdge2[0], n2 = prevPoint[0] * currentPoint[1] - prevPoint[1] * currentPoint[0], n3 = 1 / (dc[0] * dp[1] - dc[1] * dp[0]), intersection = [
+        (n1 * dp[0] - n2 * dc[0]) * n3,
+        (n1 * dp[1] - n2 * dc[1]) * n3
+    ];
+    intersection.isIntersection = true;
+    return intersection;
+};
+var PolygonClip;
+(function (PolygonClip) {
+    // Simple line string clipping. Clip to bounds and insert intersection
+    // points.
+    PolygonClip.clipLineString = function (line, boundsPolygon) {
+        var ret = [], l = PolygonClip.clipPolygon(line, boundsPolygon, false);
+        for (var i = 1; i < l.length; i++) {
+            // Insert gap where two intersections follow each other
+            if (l[i].isIntersection && l[i - 1].isIntersection) {
+                ret.push(l.splice(0, i));
+                i = 0;
+            }
+            // Push the rest
+            if (i === l.length - 1) {
+                ret.push(l);
+            }
+        }
+        return ret;
+    };
+    // Clip a polygon to another polygon using the Sutherland/Hodgman algorithm.
+    PolygonClip.clipPolygon = function (subjectPolygon, boundsPolygon, closed) {
+        if (closed === void 0) { closed = true; }
+        var clipEdge1 = boundsPolygon[boundsPolygon.length - 1], clipEdge2, prevPoint, currentPoint, outputList = subjectPolygon;
+        for (var j = 0; j < boundsPolygon.length; j++) {
+            var inputList = outputList;
+            clipEdge2 = boundsPolygon[j];
+            outputList = [];
+            prevPoint = closed ?
+                // Polygon, wrap around
+                inputList[inputList.length - 1] :
+                // Open line string, don't wrap
+                inputList[0];
+            for (var i = 0; i < inputList.length; i++) {
+                currentPoint = inputList[i];
+                if (isInside(clipEdge1, clipEdge2, currentPoint)) {
+                    if (!isInside(clipEdge1, clipEdge2, prevPoint)) {
+                        outputList.push(intersection(clipEdge1, clipEdge2, prevPoint, currentPoint));
+                    }
+                    outputList.push(currentPoint);
+                }
+                else if (isInside(clipEdge1, clipEdge2, prevPoint)) {
+                    outputList.push(intersection(clipEdge1, clipEdge2, prevPoint, currentPoint));
+                }
+                prevPoint = currentPoint;
+            }
+            clipEdge1 = clipEdge2;
+        }
+        return outputList;
+    };
+})(PolygonClip || (PolygonClip = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default PolygonClip;

package/es-modules/Core/Globals.js

@@ -8,23 +8,6 @@
  *
  * */
 'use strict';
-/* *
- *
- *  Constants
- *
- * */
-/**
- * @private
- * @deprecated
- * @todo Rename UMD argument `win` to `window`; move code to `Globals.win`
- */
-var w = (typeof win !== 'undefined' ?
-    win :
-    typeof window !== 'undefined' ?
-        window :
-        {}
-// eslint-disable-next-line node/no-unsupported-features/es-builtins
-);
 /* *
  *
  *  Namespace
@@ -40,7 +23,10 @@ var Globals;
      *  Constants
      *
      * */
-    Globals.SVG_NS = 'http://www.w3.org/2000/svg', Globals.product = 'Highcharts', Globals.version = '9.3.1', Globals.win = w, Globals.doc = Globals.win.document, Globals.svg = (Globals.doc &&
+    Globals.SVG_NS = 'http://www.w3.org/2000/svg', Globals.product = 'Highcharts', Globals.version = '10.0.0', Globals.win = (typeof window !== 'undefined' ?
+        window :
+        {}), // eslint-disable-line node/no-unsupported-features/es-builtins
+    Globals.doc = Globals.win.document, Globals.svg = (Globals.doc &&
         Globals.doc.createElementNS &&
         !!Globals.doc.createElementNS(Globals.SVG_NS, 'svg').createSVGRect), Globals.userAgent = (Globals.win.navigator && Globals.win.navigator.userAgent) || '', Globals.isChrome = Globals.userAgent.indexOf('Chrome') !== -1, Globals.isFirefox = Globals.userAgent.indexOf('Firefox') !== -1, Globals.isMS = /(edge|msie|trident)/i.test(Globals.userAgent) && !Globals.win.opera, Globals.isSafari = !Globals.isChrome && Globals.userAgent.indexOf('Safari') !== -1, Globals.isTouchDevice = /(Mobile|Android|Windows Phone)/.test(Globals.userAgent), Globals.isWebKit = Globals.userAgent.indexOf('AppleWebKit') !== -1, Globals.deg2rad = Math.PI * 2 / 360, Globals.hasBidiBug = (Globals.isFirefox &&
         parseInt(Globals.userAgent.split('Firefox/')[1], 10) < 4 // issue #38

package/es-modules/Core/HttpUtilities.js

@@ -40,9 +40,10 @@ function ajax(attr) {
     }, r = new XMLHttpRequest();
     /**
      * @private
-     * @param {XMLHttpRequest} xhr - Internal request object.
-     * @param {string|Error} err - Occured error.
-     * @return {void}
+     * @param {XMLHttpRequest} xhr
+     * Internal request object.
+     * @param {string|Error} err
+     * Occured error.
      */
     function handleError(xhr, err) {
         if (options.error) {
@@ -62,21 +63,26 @@ function ajax(attr) {
     objectEach(options.headers, function (val, key) {
         r.setRequestHeader(key, val);
     });
+    if (options.responseType) {
+        r.responseType = options.responseType;
+    }
     // @todo lacking timeout handling
     r.onreadystatechange = function () {
         var res;
         if (r.readyState === 4) {
             if (r.status === 200) {
-                res = r.responseText;
-                if (options.dataType === 'json') {
-                    try {
-                        res = JSON.parse(res);
-                    }
-                    catch (e) {
-                        return handleError(r, e);
+                if (options.responseType !== 'blob') {
+                    res = r.responseText;
+                    if (options.dataType === 'json') {
+                        try {
+                            res = JSON.parse(res);
+                        }
+                        catch (e) {
+                            return handleError(r, e);
+                        }
                     }
                 }
-                return options.success && options.success(res);
+                return options.success && options.success(res, r);
             }
             handleError(r, r.responseText);
         }
@@ -120,7 +126,7 @@ function getJSON(url, success) {
  * @param {string} url
  * Post URL
  *
- * @param {object} data
+ * @param {Object} data
  * Post data
  *
  * @param {Highcharts.Dictionary<string>} [formAttributes]