highcharts 7.1.1 → 7.1.2

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

@@ -9,9 +9,9 @@
 /**
  * Formatter callback function.
  *
- * @callback Highcharts.PlotNetworkDataLabelsFormatterCallbackFunction
+ * @callback Highcharts.SeriesNetworkDataLabelsFormatterCallbackFunction
  *
- * @param {Highcharts.PlotNetworkDataLabelsFormatterContextObject|Highcharts.DataLabelsFormatterContextObject} this
+ * @param {Highcharts.SeriesNetworkDataLabelsFormatterContextObject|Highcharts.DataLabelsFormatterContextObject} this
  *        Data label context to format
  *
  * @return {string}
@@ -21,24 +21,24 @@
 /**
  * Context for the formatter function.
  *
- * @interface Highcharts.PlotNetworkDataLabelsFormatterContextObject
+ * @interface Highcharts.SeriesNetworkDataLabelsFormatterContextObject
  * @extends Highcharts.DataLabelsFormatterContextObject
  * @since 7.0.0
  *//**
  * The color of the node.
- * @name Highcharts.PlotNetworkDataLabelsFormatterContextObject#color
+ * @name Highcharts.SeriesNetworkDataLabelsFormatterContextObject#color
  * @type {Highcharts.ColorString}
  * @since 7.0.0
  *//**
  * The point (node) object. The node name, if defined, is available through
  * `this.point.name`. Arrays: `this.point.linksFrom` and `this.point.linksTo`
  * contains all nodes connected to this point.
- * @name Highcharts.PlotNetworkDataLabelsFormatterContextObject#point
+ * @name Highcharts.SeriesNetworkDataLabelsFormatterContextObject#point
  * @type {Highcharts.Point}
  * @since 7.0.0
  *//**
  * The ID of the node.
- * @name Highcharts.PlotNetworkDataLabelsFormatterContextObject#key
+ * @name Highcharts.SeriesNetworkDataLabelsFormatterContextObject#key
  * @type {string}
  * @since 7.0.0
  */
@@ -46,7 +46,7 @@
 /**
  * Data labels options
  *
- * @interface Highcharts.PlotNetworkDataLabelsOptionsObject
+ * @interface Highcharts.SeriesNetworkDataLabelsOptionsObject
  * @extends Highcharts.DataLabelsOptionsObject
  * @since 7.0.0
  *//**
@@ -54,63 +54,38 @@
  * [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
  * specifying what to show for _node_ in the networkgraph. In v7.0 defaults to
  * `{key}`, since v7.1 defaults to `undefined` and `formatter` is used instead.
- * @name Highcharts.PlotNetworkDataLabelsOptionsObject#format
+ * @name Highcharts.SeriesNetworkDataLabelsOptionsObject#format
  * @type {string}
  * @since 7.0.0
  *//**
  * Callback JavaScript function to format the data label for a node. Note that
  * if a `format` is defined, the format takes precedence and the formatter is
  * ignored.
- * @name Highcharts.PlotNetworkDataLabelsOptionsObject#formatter
- * @type {Highcharts.PlotNetworkDataLabelsFormatterCallbackFunction|undefined}
+ * @name Highcharts.SeriesNetworkDataLabelsOptionsObject#formatter
+ * @type {Highcharts.SeriesNetworkDataLabelsFormatterCallbackFunction|undefined}
  * @since 7.0.0
  *//**
  * The
  * [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
  * specifying what to show for _links_ in the networkgraph. (Default:
  * `undefined`)
- * @name Highcharts.PlotNetworkDataLabelsOptionsObject#linkFormat
+ * @name Highcharts.SeriesNetworkDataLabelsOptionsObject#linkFormat
  * @type {string}
  * @since 7.1.0
  *//**
  * Callback to format data labels for _links_ in the sankey diagram. The
  * `linkFormat` option takes precedence over the `linkFormatter`.
- * @name Highcharts.PlotNetworkDataLabelsOptionsObject#linkFormatter
- * @type {Highcharts.PlotNetworkDataLabelsFormatterCallbackFunction|undefined}
+ * @name Highcharts.SeriesNetworkDataLabelsOptionsObject#linkFormatter
+ * @type {Highcharts.SeriesNetworkDataLabelsFormatterCallbackFunction|undefined}
  * @since 7.1.0
  *//**
- * Options for a _link_ label text which should follow link connection.
- * **Note:** Only SVG-based renderer supports this option.
- * @see {@link Highcharts.PlotNetworkDataLabelsTextPath#textPath}
- * @name Highcharts.PlotNetworkDataLabelsOptionsObject#linkTextPath
- * @type {Highcharts.PlotNetworkDataLabelsTextPath}
- * @since 7.1.0
- *//**
- * Options for a _node_ label text which should follow marker's shape.
- * **Note:** Only SVG-based renderer supports this option.
- * @see {@link Highcharts.PlotNetworkDataLabelsTextPath#linkTextPath}
- * @name Highcharts.PlotNetworkDataLabelsOptionsObject#textPath
- * @type {Highcharts.PlotNetworkDataLabelsTextPath}
- * @since 7.1.0
- */
-
-/**
- * **Note:** Only SVG-based renderer supports this option.
- *
- * @see {@link Highcharts.PlotNetworkDataLabelsTextPath#linkTextPath}
- * @see {@link Highcharts.PlotNetworkDataLabelsTextPath#textPath}
- *
- * @interface Highcharts.PlotNetworkDataLabelsTextPath
- * @since 7.1.0
- *//**
- * Presentation attributes for the text path.
- * @name Highcharts.PlotNetworkDataLabelsTextPath#attributes
- * @type {Highcharts.SVGAttributes}
- * @since 7.1.0
- *//**
- * Enable or disable `textPath` option for link's or marker's data labels.
- * @name Highcharts.PlotNetworkDataLabelsTextPath#enabled
- * @type {boolean|undefined}
+ * Options for a _link_ label text which should follow link connection. Border
+ * and background are disabled for a label that follows a path.
+ * **Note:** Only SVG-based renderer supports this option. Setting `useHTML` to
+ * true will disable this option.
+ * @see {@link Highcharts.SeriesNetworkDataLabelsTextPath#textPath}
+ * @name Highcharts.SeriesNetworkDataLabelsOptionsObject#linkTextPath
+ * @type {Highcharts.DataLabelsTextPath|undefined}
  * @since 7.1.0
  */
 
@@ -163,7 +138,10 @@ seriesType(
     {
         stickyTracking: false,
 
-        /** @ignore-option */
+        /**
+         * @ignore-option
+         * @private
+         */
         inactiveOtherPoints: true,
 
         marker: {
@@ -224,7 +202,9 @@ seriesType(
          * @sample highcharts/series-networkgraph/link-datalabels
          *         Data labels moved under the links
          *
-         * @type {Highcharts.PlotNetworkDataLabelsOptionsObject}
+         * @type    {Highcharts.SeriesNetworkDataLabelsOptionsObject|Array<Highcharts.SeriesNetworkDataLabelsOptionsObject>}
+         * @default {"formatter": function () { return this.key; }, "linkFormatter": function () { return this.point.fromNode.name + "<br>" + this.point.toNode.name; }, "linkTextPath": {"enabled": true}, "textPath": {"enabled": false}}
+         *
          * @private
          */
         dataLabels: {
@@ -328,7 +308,7 @@ seriesType(
              *         Numerical values
              *
              * @type      {number}
-             * @apioption series.networkgraph.layoutAlgorithm.linkLength
+             * @apioption plotOptions.networkgraph.layoutAlgorithm.linkLength
              */
 
             /**
@@ -485,7 +465,6 @@ seriesType(
          * @private
          */
         createNode: H.NodesMixin.createNode,
-        setData: H.NodesMixin.setData,
         destroy: H.NodesMixin.destroy,
 
         /**
@@ -512,6 +491,9 @@ seriesType(
          * @private
          */
         generatePoints: function () {
+            var node,
+                i;
+
             H.NodesMixin.generatePoints.apply(this, arguments);
 
             // In networkgraph, it's fine to define stanalone nodes, create
@@ -528,9 +510,19 @@ seriesType(
                 );
             }
 
-            this.nodes.forEach(function (node) {
+            for (i = this.nodes.length - 1; i >= 0; i--) {
+                node = this.nodes[i];
+
                 node.degree = node.getDegree();
-            });
+
+                // If node exists, but it's not available in nodeLookup,
+                // then it's leftover from previous runs (e.g. setData)
+                if (!this.nodeLookup[node.id]) {
+                    node.remove();
+                }
+            }
+
+
             this.data.forEach(function (link) {
                 link.formatPrefix = 'link';
             });
@@ -947,6 +939,105 @@ seriesType(
             return !this.isNode || defined(this.id);
         },
 
+        /**
+         * Common method for removing points and nodes in networkgraph. To
+         * remove `link`, use `series.data[index].remove()`. To remove `node`
+         * with all connections, use `series.nodes[index].remove()`.
+         * @private
+         * @param {boolean} [redraw=true]
+         *        Whether to redraw the chart or wait for an explicit call. When
+         *        doing more operations on the chart, for example running
+         *        `point.remove()` in a loop, it is best practice to set
+         *        `redraw` to false and call `chart.redraw()` after.
+         * @param {boolean|Highcharts.AnimationOptionsObject} [animation=false]
+         *        Whether to apply animation, and optionally animation
+         *        configuration.
+         * @return {void}
+         */
+        remove: function (redraw, animation) {
+            var point = this,
+                series = point.series,
+                nodesOptions = series.options.nodes || [],
+                index,
+                i = nodesOptions.length;
+
+            // For nodes, remove all connected links:
+            if (point.isNode) {
+                // Temporary disable series.points array, because
+                // Series.removePoint() modifies it
+                series.points = [];
+
+                // Remove link from all nodes collections:
+                [].concat(point.linksFrom)
+                    .concat(point.linksTo)
+                    .forEach(
+                        function (linkFromTo) {
+                            // Incoming links
+                            index = linkFromTo.fromNode.linksFrom.indexOf(
+                                linkFromTo
+                            );
+                            if (index > -1) {
+                                linkFromTo.fromNode.linksFrom.splice(
+                                    index,
+                                    1
+                                );
+                            }
+
+                            // Outcoming links
+                            index = linkFromTo.toNode.linksTo.indexOf(
+                                linkFromTo
+                            );
+                            if (index > -1) {
+                                linkFromTo.toNode.linksTo.splice(
+                                    index,
+                                    1
+                                );
+                            }
+
+                            // Remove link from data/points collections
+                            Series.prototype.removePoint.call(
+                                series,
+                                series.data.indexOf(linkFromTo),
+                                false,
+                                false
+                            );
+                        }
+                    );
+
+                // Restore points array, after links are removed
+                series.points = series.data.slice();
+
+                // Proceed with removing node. It's similar to
+                // Series.removePoint() method, but doesn't modify other arrays
+                series.nodes.splice(series.nodes.indexOf(point), 1);
+
+                // Remove node options from config
+                while (i--) {
+                    if (nodesOptions[i].id === point.options.id) {
+                        series.options.nodes.splice(i, 1);
+                        break;
+                    }
+                }
+
+                if (point) {
+                    point.destroy();
+                }
+
+                // Run redraw if requested
+                series.isDirty = true;
+                series.isDirtyData = true;
+                if (redraw) {
+                    series.chart.redraw(redraw);
+                }
+            } else {
+                series.removePoint(
+                    series.data.indexOf(point),
+                    redraw,
+                    animation
+                );
+            }
+        },
+
         /**
          * Destroy point. If it's a node, remove all links coming out of this
          * node. Then remove point from the layout.
@@ -1021,6 +1112,11 @@ seriesType(
  * @apioption series.networkgraph.data
  */
 
+/**
+ * @type      {Highcharts.SeriesNetworkDataLabelsOptionsObject|Array<Highcharts.SeriesNetworkDataLabelsOptionsObject>}
+ * @product   highcharts
+ * @apioption series.networkgraph.data.dataLabels
+ */
 
 /**
  * The node that the link runs from.

package/es-modules/modules/offline-exporting.src.js

@@ -1,4 +1,4 @@
-/**
+/* *
  * Client side exporting module
  *
  * (c) 2015 Torstein Honsi / Oystein Moseng
@@ -614,6 +614,19 @@ Highcharts.Chart.prototype.exportChartLocal = function (
                     fallbackToExportServer
                 );
             }
+        },
+
+        // Return true if the SVG contains images with external data. With the
+        // boost module there are `image` elements with encoded PNGs, these are
+        // supported by svg2pdf and should pass (#10243).
+        hasExternalImages = function () {
+            return [].some.call(
+                chart.container.getElementsByTagName('image'),
+                function (image) {
+                    var href = image.getAttribute('href');
+                    return href !== '' && href.indexOf('data:') !== 0;
+                }
+            );
         };
 
     // If we are on IE and in styled mode, add a whitelist to the renderer for
@@ -665,7 +678,7 @@ Highcharts.Chart.prototype.exportChartLocal = function (
             )
         ) || (
             options.type === 'application/pdf' &&
-            chart.container.getElementsByTagName('image').length
+            hasExternalImages()
         )
     ) {
         fallbackToExportServer(

package/es-modules/modules/oldie-polyfills.src.js

@@ -1,4 +1,4 @@
-/**
+/* *
  * (c) 2010-2019 Torstein Honsi
  *
  * Simple polyfills for array functions in old IE browsers (6, 7 and 8) in

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

@@ -14,6 +14,29 @@
  * @typedef {"normal"|"hanging"} Highcharts.SeriesOrganizationNodesLayoutValue
  */
 
+/**
+ * @interface Highcharts.SeriesOrganizationDataLabelsOptionsObject
+ * @extends Highcharts.SeriesSankeyDataLabelsOptionsObject
+ *//**
+ * A callback for defining the format for _nodes_ in the
+ * organization chart. The `nodeFormat` option takes precedence over
+ * `nodeFormatter`.
+ *
+ * In an organization chart, the `nodeFormatter` is a quite complex
+ * function of the available options, striving for a good default
+ * layout of cards with or without images. In organization chart,
+ * the data labels come with `useHTML` set to true, meaning they
+ * will be rendered as true HTML above the SVG.
+ *
+ * @sample highcharts/series-organization/datalabels-nodeformatter
+ *         Modify the default label format output
+ *
+ * @name Highcharts.SeriesOrganizationDataLabelsOptionsObject#nodeFormatter
+ * @type {Highcharts.FormatterCallbackFunction<Highcharts.SankeyNodeObject>|undefined}
+ * @default function () { return this.point.name; }
+ * @since 6.0.2
+ */
+
 'use strict';
 
 import H from '../parts/Globals.js';
@@ -54,11 +77,15 @@ H.seriesType(
     {
         /**
          * The border color of the node cards.
+         *
          * @type {Highcharts.ColorString}
+         * @private
          */
         borderColor: '#666666',
         /**
          * The border radius of the node cards.
+         *
+         * @private
          */
         borderRadius: 3,
         /**
@@ -66,24 +93,17 @@ H.seriesType(
          *
          * @sample   highcharts/series-organization/link-options
          *           Square links
+         *
+         * @private
          */
         linkRadius: 10,
         borderWidth: 1,
+        /**
+         * @type {Highcharts.SeriesOrganizationDataLabelsOptionsObject|Array<Highcharts.SeriesOrganizationDataLabelsOptionsObject>}
+         * @private
+         */
         dataLabels: {
-            /**
-             * A callback for defining the format for _nodes_ in the
-             * organization chart. The `nodeFormat` option takes precedence over
-             * `nodeFormatter`.
-             *
-             * In an organization chart, the `nodeFormatter` is a quite complex
-             * function of the available options, striving for a good default
-             * layout of cards with or without images. In organization chart,
-             * the data labels come with `useHTML` set to true, meaning they
-             * will be rendered as true HTML above the SVG.
-             *
-             * @sample highcharts/series-organization/datalabels-nodeformatter
-             *         Modify the default label format output
-             */
+            /** @ignore-option */
             nodeFormatter: function () {
 
                 var outerStyle = {
@@ -163,20 +183,26 @@ H.seriesType(
                     '</div>';
                 return html;
             },
+            /** @ignore-option */
             style: {
                 fontWeight: 'normal',
                 fontSize: '13px'
             },
+            /** @ignore-option */
             useHTML: true
         },
         /**
          * The indentation in pixels of hanging nodes, nodes which parent has
          * [layout](#series.organization.nodes.layout) set to `hanging`.
+         *
+         * @private
          */
         hangingIndent: 20,
         /**
          * The color of the links between nodes.
+         *
          * @type {Highcharts.ColorString}
+         * @private
          */
         linkColor: '#666666',
         /**
@@ -184,12 +210,16 @@ H.seriesType(
          *
          * @sample   highcharts/series-organization/link-options
          *           Square links
+         *
+         * @private
          */
         linkLineWidth: 1,
         /**
          * In a horizontal chart, the width of the nodes in pixels. Node that
          * most organization charts are vertical, so the name of this option
          * is counterintuitive.
+         *
+         * @private
          */
         nodeWidth: 50,
         tooltip: {
@@ -463,9 +493,16 @@ H.seriesType(
  * not specified, it is inherited from [chart.type](#chart.type).
  *
  * @extends   series,plotOptions.organization
+ * @product   highcharts
  * @apioption series.organization
  */
 
+/**
+ * @type      {Highcharts.SeriesOrganizationDataLabelsOptionsObject|Array<Highcharts.SeriesOrganizationDataLabelsOptionsObject>}
+ * @product   highcharts
+ * @apioption series.organization.data.dataLabels
+ */
+
 /**
  * A collection of options for the individual nodes. The nodes in an org chart
  * are auto-generated instances of `Highcharts.Point`, but options can be
@@ -473,6 +510,7 @@ H.seriesType(
  *
  * @extends   series.sankey.nodes
  * @type      {Array<*>}
+ * @product   highcharts
  * @apioption series.organization.nodes
  */
 
@@ -480,9 +518,11 @@ H.seriesType(
  * The job description for the node card, will be inserted by the default
  * `dataLabel.nodeFormatter`.
  *
+ * @sample highcharts/demo/organization-chart
+ *         Org chart with job descriptions
+ *
  * @type      {string}
- * @sample    highcharts/demo/organization-chart
- *            Org chart with job descriptions
+ * @product   highcharts
  * @apioption series.organization.nodes.description
  */
 
@@ -490,9 +530,11 @@ H.seriesType(
  * An image for the node card, will be inserted by the default
  * `dataLabel.nodeFormatter`.
  *
+ * @sample highcharts/demo/organization-chart
+ *         Org chart with images
+ *
  * @type      {string}
- * @sample    highcharts/demo/organization-chart
- *            Org chart with images
+ * @product   highcharts
  * @apioption series.organization.nodes.image
  */
 
@@ -505,6 +547,7 @@ H.seriesType(
  *
  * @type      {Highcharts.SeriesOrganizationNodesLayoutValue}
  * @default   normal
+ * @product   highcharts
  * @apioption series.organization.nodes.layout
  */
 
@@ -512,9 +555,11 @@ H.seriesType(
  * The job title for the node card, will be inserted by the default
  * `dataLabel.nodeFormatter`.
  *
+ * @sample highcharts/demo/organization-chart
+ *         Org chart with job titles
+ *
  * @type      {string}
- * @sample    highcharts/demo/organization-chart
- *            Org chart with job titles
+ * @product   highcharts
  * @apioption series.organization.nodes.title
  */
 

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

@@ -28,40 +28,41 @@ var correctFloat = H.correctFloat,
 seriesType('pareto', 'line'
 
     /**
- * A pareto diagram is a type of chart that contains both bars and a line graph,
- * where individual values are represented in descending order by bars, and the
- * cumulative total is represented by the line.
- *
- * @sample {highcharts} highcharts/demo/pareto/
- *         Pareto diagram
- *
- * @extends      plotOptions.line
- * @since        6.0.0
- * @product      highcharts
- * @excluding    allAreas, boostThreshold, borderColor, borderRadius,
- *               borderWidth, crisp, colorAxis, depth, data, edgeColor,
- *               edgeWidth, findNearestPointBy, gapSize, gapUnit, grouping,
- *               groupPadding, groupZPadding, maxPointWidth, keys,
- *               negativeColor, pointInterval, pointIntervalUnit, pointPadding,
- *               pointPlacement, pointRange, pointStart, pointWidth, shadow,
- *               step, softThreshold, stacking, threshold, zoneAxis, zones
- * @optionparent plotOptions.pareto
- */
-    , {
-    /**
-     * Higher zIndex than column series to draw line above shapes.
-     */
-        zIndex: 3
-    }, merge(derivedSeriesMixin, {
-    /**
-     * Calculate sum and return percent points.
+     * A pareto diagram is a type of chart that contains both bars and a line
+     * graph, where individual values are represented in descending order by
+     * bars, and the cumulative total is represented by the line.
      *
-     * @private
-     * @function Highcharts.Series#setDerivedData
+     * @sample {highcharts} highcharts/demo/pareto/
+     *         Pareto diagram
      *
-     * @return {Array<Array<number,number>>}
-     *         Returns array of points [x,y]
+     * @extends      plotOptions.line
+     * @since        6.0.0
+     * @product      highcharts
+     * @excluding    allAreas, boostThreshold, borderColor, borderRadius,
+     *               borderWidth, crisp, colorAxis, depth, data, edgeColor,
+     *               edgeWidth, findNearestPointBy, gapSize, gapUnit, grouping,
+     *               groupPadding, groupZPadding, maxPointWidth, keys,
+     *               negativeColor, pointInterval, pointIntervalUnit,
+     *               pointPadding, pointPlacement, pointRange, pointStart,
+     *               pointWidth, shadow, step, softThreshold, stacking,
+     *               threshold, zoneAxis, zones
+     * @optionparent plotOptions.pareto
      */
+    , {
+        /**
+         * Higher zIndex than column series to draw line above shapes.
+         */
+        zIndex: 3
+    }, merge(derivedSeriesMixin, {
+        /**
+         * Calculate sum and return percent points.
+         *
+         * @private
+         * @function Highcharts.Series#setDerivedData
+         *
+         * @return {Array<Array<number,number>>}
+         *         Returns array of points [x,y]
+         */
         setDerivedData: function () {
             if (this.baseSeries.yData.length > 1) {
                 var xValues = this.baseSeries.xData,
@@ -75,26 +76,26 @@ seriesType('pareto', 'line'
             }
         },
         /**
-     * Calculate y sum and each percent point.
-     *
-     * @private
-     * @function Highcharts.Series#sumPointsPercents
-     *
-     * @param {Array<number>} yValues
-     *        Y values
-     *
-     * @param {Array<number>} xValues
-     *        X values
-     *
-     * @param {number} sum
-     *        Sum of all y values
-     *
-     * @param {boolean} [isSum]
-     *        Declares if calculate sum of all points
-     *
-     * @return {number|Array<number,number>}
-     *         Returns sum of points or array of points [x,sum]
-     */
+         * Calculate y sum and each percent point.
+         *
+         * @private
+         * @function Highcharts.Series#sumPointsPercents
+         *
+         * @param {Array<number>} yValues
+         *        Y values
+         *
+         * @param {Array<number>} xValues
+         *        X values
+         *
+         * @param {number} sum
+         *        Sum of all y values
+         *
+         * @param {boolean} [isSum]
+         *        Declares if calculate sum of all points
+         *
+         * @return {number|Array<number,number>}
+         *         Returns sum of points or array of points [x,sum]
+         */
         sumPointsPercents: function (yValues, xValues, sum, isSum) {
             var sumY = 0,
                 sumPercent = 0,

package/es-modules/modules/pattern-fill.src.js

@@ -21,7 +21,7 @@
  * is 32px. Note that automatic resizing of image patterns to fill a bounding
  * box dynamically is only supported for patterns with an automatically
  * calculated ID.
- * @name Highcharts.PatternOptionsObject#with
+ * @name Highcharts.PatternOptionsObject#width
  * @type {number}
  *//**
  * Analogous to pattern.width.

package/es-modules/modules/price-indicator.src.js

@@ -1,4 +1,4 @@
-/**
+/* *
  * (c) 2009-2019 Sebastian Bochann
  *
  * Price indicator for Highcharts