highcharts 6.1.4 → 6.2.0

package/es-modules/parts/DataGrouping.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -536,11 +536,14 @@ seriesProto.groupData = function (xData, yData, groupPositions, approximation) {
             // write custom options to `this.dataGroupInfo.options`.
             if (!defined(series.dataGroupInfo.options)) {
                 // Convert numbers and arrays into objects
-                series.dataGroupInfo.options = series.pointClass.prototype
-                    .optionsToObject.call(
-                        { series: series },
-                        series.options.data[start]
-                    );
+                series.dataGroupInfo.options = merge(
+                    series.pointClass.prototype
+                        .optionsToObject.call(
+                            { series: series },
+                            series.options.data[start]
+                        )
+                );
+
                 // Make sure the raw data (x, y, open, high etc) is not copied
                 // over and overwriting approximated data.
                 each(extendedPointArrayMap, function (key) {

package/es-modules/parts/DataLabels.js

@@ -1,49 +1,15 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
 
-/**
- * A label box.
- *
- * @typedef {object} Highcharts.DataLabelBoxObject
- *
- * @property {number} align
- *
- * @property {number} pos
- *
- * @property {number} rank
- *
- * @property {number} size
- *
- * @property {number} target
- */
-
-/**
- * Alignment offset for a label.
- *
- * @typedef {object} Highcharts.DataLabelAlignObject
- *
- * @property {number} x
- *
- * @property {number} y
- */
-
-/**
- * Label position for a pie slice.
- *
- * @typedef {Array<number|string>} Highcharts.DataLabelPiePosObject
- *
- * @property {number} x
- *
- * @property {number} y
- */
-
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
 import './Series.js';
+
 var addEvent = H.addEvent,
     arrayMax = H.arrayMax,
     defined = H.defined,
@@ -58,8 +24,9 @@ var addEvent = H.addEvent,
     Series = H.Series,
     seriesTypes = H.seriesTypes,
     some = H.some,
-    stableSort = H.stableSort;
-
+    stableSort = H.stableSort,
+    isArray = H.isArray,
+    splat = H.splat;
 
 /**
  * General distribution algorithm for distributing labels of differing size
@@ -68,15 +35,14 @@ var addEvent = H.addEvent,
  * close as possible to their targets, skipping the lowest ranked labels if
  * necessary.
  *
+ * @private
  * @function Highcharts.distribute
  *
- * @param  {Array<Highcharts.DataLabelBoxObject>} boxes
- *
- * @param  {number} len
+ * @param {Array<object>} boxes
  *
- * @param  {number} maxDistance
+ * @param {number} len
  *
- * @return {void}
+ * @param {number} maxDistance
  */
 H.distribute = function (boxes, len, maxDistance) {
 
@@ -222,25 +188,21 @@ H.distribute = function (boxes, len, maxDistance) {
 /**
  * Draw the data labels
  *
+ * @private
  * @function Highcharts.Series#drawDataLabels
  *
- * @return {void}
- *
- * @todo
- * Make events official: Fires the event `afterDrawDataLabels`.
+ * @fires Highcharts.Series#event:afterDrawDataLabels
  */
 Series.prototype.drawDataLabels = function () {
     var series = this,
         chart = series.chart,
         seriesOptions = series.options,
-        options = seriesOptions.dataLabels,
+        seriesDlOptions = seriesOptions.dataLabels,
         points = series.points,
         pointOptions,
-        generalOptions,
         hasRendered = series.hasRendered || 0,
-        str,
         dataLabelsGroup,
-        defer = pick(options.defer, !!seriesOptions.animation),
+        defer = pick(seriesDlOptions.defer, !!seriesOptions.animation),
         renderer = chart.renderer;
 
     /*
@@ -270,19 +232,59 @@ Series.prototype.drawDataLabels = function () {
         return true;
     }
 
-    if (options.enabled || series._hasPointLabels) {
-
-        // Process default alignment of data labels for columns
-        if (series.dlProcessOptions) {
-            series.dlProcessOptions(options);
+    /*
+     * Merge two objects that can be arrays. If one of them is an array, the
+     * other is merged into each element. If both are arrays, each element is
+     * merged by index. If neither are arrays, we use normal merge.
+     */
+    function mergeArrays(one, two) {
+        var res = [],
+            i;
+        if (isArray(one) && !isArray(two)) {
+            res = map(one, function (el) {
+                return merge(el, two);
+            });
+        } else if (isArray(two) && !isArray(one)) {
+            res = map(two, function (el) {
+                return merge(one, el);
+            });
+        } else if (!isArray(one) && !isArray(two)) {
+            res = merge(one, two);
+        } else {
+            i = Math.max(one.length, two.length);
+            while (i--) {
+                res[i] = merge(one[i], two[i]);
+            }
         }
+        return res;
+    }
+
+
+    // Merge in plotOptions.dataLabels for series
+    seriesDlOptions = mergeArrays(
+        mergeArrays(
+            chart.options.plotOptions &&
+            chart.options.plotOptions.series &&
+            chart.options.plotOptions.series.dataLabels,
+            chart.options.plotOptions &&
+            chart.options.plotOptions[series.type] &&
+            chart.options.plotOptions[series.type].dataLabels
+        ),
+        seriesDlOptions
+    );
+
+    if (
+        isArray(seriesDlOptions) ||
+        seriesDlOptions.enabled ||
+        series._hasPointLabels
+    ) {
 
         // Create a separate group for the data labels to avoid rotation
         dataLabelsGroup = series.plotGroup(
             'dataLabelsGroup',
             'data-labels',
             defer && !hasRendered ? 'hidden' : 'visible', // #5133
-            options.zIndex || 6
+            seriesDlOptions.zIndex || 6
         );
 
         if (defer) {
@@ -300,149 +302,193 @@ Series.prototype.drawDataLabels = function () {
         }
 
         // Make the labels for each point
-        generalOptions = options;
         each(points, function (point) {
-            var enabled,
-                dataLabel = point.dataLabel,
-                labelConfig,
-                attr,
-                rotation,
-                connector = point.connector,
-                isNew = !dataLabel,
-                style,
-                formatString;
-
-            // Determine if each data label is enabled
+
+            // Merge in series options for the point.
             // @note dataLabelAttribs (like pointAttribs) would eradicate
             // the need for dlOptions, and simplify the section below.
-            pointOptions = point.dlOptions || // dlOptions is used in treemaps
-                (point.options && point.options.dataLabels);
-            enabled = pick(
-                pointOptions && pointOptions.enabled,
-                generalOptions.enabled
-            ) && !point.isNull; // #2282, #4641, #7112
-
-            if (enabled) {
-                enabled = applyFilter(point, pointOptions || options) === true;
-            }
+            pointOptions = splat(
+                mergeArrays(
+                    seriesDlOptions,
+                    point.dlOptions || // dlOptions is used in treemaps
+                        (point.options && point.options.dataLabels)
+                )
+            );
 
-            if (enabled) {
-                // Create individual options structure that can be extended
-                // without affecting others
-                options = merge(generalOptions, pointOptions);
-                labelConfig = point.getLabelConfig();
-                formatString = (
-                    options[point.formatPrefix + 'Format'] ||
-                    options.format
-                );
+            // Handle each individual data label for this point
+            each(pointOptions, function (labelOptions, i) {
+                // Options for one datalabel
+                var labelEnabled = labelOptions.enabled &&
+                        !point.isNull && // #2282, #4641, #7112
+                        applyFilter(point, labelOptions),
+                    labelConfig,
+                    formatString,
+                    labelText,
+                    style,
+                    rotation,
+                    attr,
+                    dataLabel = point.dataLabels ? point.dataLabels[i] :
+                        point.dataLabel,
+                    connector = point.connectors ? point.connectors[i] :
+                        point.connector,
+                    isNew = !dataLabel;
+
+                if (labelEnabled) {
+                    // Create individual options structure that can be extended
+                    // without affecting others
+                    labelConfig = point.getLabelConfig();
+                    formatString = (
+                        labelOptions[point.formatPrefix + 'Format'] ||
+                        labelOptions.format
+                    );
 
-                str = defined(formatString) ?
-                    format(formatString, labelConfig, chart.time) :
-                    (
-                        options[point.formatPrefix + 'Formatter'] ||
-                        options.formatter
-                    ).call(labelConfig, options);
-
-                style = options.style;
-                rotation = options.rotation;
-                
-                // Determine the color
-                style.color = pick(
-                    options.color,
-                    style.color,
-                    series.color,
-                    '#000000'
-                );
-                // Get automated contrast color
-                if (style.color === 'contrast') {
-                    point.contrastColor =
-                        renderer.getContrast(point.color || series.color);
-                    style.color = options.inside ||
-                        pick(point.labelDistance, options.distance) < 0 ||
-                        !!seriesOptions.stacking ?
-                            point.contrastColor :
-                            '#000000';
-                }
-                if (seriesOptions.cursor) {
-                    style.cursor = seriesOptions.cursor;
-                }
-                
+                    labelText = defined(formatString) ?
+                        format(formatString, labelConfig, chart.time) :
+                        (
+                            labelOptions[point.formatPrefix + 'Formatter'] ||
+                            labelOptions.formatter
+                        ).call(labelConfig, labelOptions);
 
-                attr = {
+                    style = labelOptions.style;
+                    rotation = labelOptions.rotation;
                     
-                    fill: options.backgroundColor,
-                    stroke: options.borderColor,
-                    'stroke-width': options.borderWidth,
+                    // Determine the color
+                    style.color = pick(
+                        labelOptions.color,
+                        style.color,
+                        series.color,
+                        '#000000'
+                    );
+                    // Get automated contrast color
+                    if (style.color === 'contrast') {
+                        point.contrastColor =
+                            renderer.getContrast(point.color || series.color);
+                        style.color = labelOptions.inside ||
+                            pick(
+                                labelOptions.distance,
+                                point.labelDistance
+                            ) < 0 ||
+                            !!seriesOptions.stacking ?
+                                point.contrastColor :
+                                '#000000';
+                    }
+                    if (seriesOptions.cursor) {
+                        style.cursor = seriesOptions.cursor;
+                    }
                     
-                    r: options.borderRadius || 0,
-                    rotation: rotation,
-                    padding: options.padding,
-                    zIndex: 1
-                };
 
-                // Remove unused attributes (#947)
-                H.objectEach(attr, function (val, name) {
-                    if (val === undefined) {
-                        delete attr[name];
-                    }
-                });
-            }
-            // If the point is outside the plot area, destroy it. #678, #820
-            if (dataLabel && (!enabled || !defined(str))) {
-                point.dataLabel = dataLabel = dataLabel.destroy();
-                if (connector) {
-                    point.connector = connector.destroy();
+                    attr = {
+                        
+                        fill: labelOptions.backgroundColor,
+                        stroke: labelOptions.borderColor,
+                        'stroke-width': labelOptions.borderWidth,
+                        
+                        r: labelOptions.borderRadius || 0,
+                        rotation: rotation,
+                        padding: labelOptions.padding,
+                        zIndex: 1
+                    };
+
+                    // Remove unused attributes (#947)
+                    H.objectEach(attr, function (val, name) {
+                        if (val === undefined) {
+                            delete attr[name];
+                        }
+                    });
                 }
-            // Individual labels are disabled if the are explicitly disabled
-            // in the point options, or if they fall outside the plot area.
-            } else if (enabled && defined(str)) {
-                // create new label
-                if (!dataLabel) {
-                    dataLabel = point.dataLabel = rotation ?
-
-                        renderer
-                            .text( // labels don't rotate
-                                str,
+
+                // If the point is outside the plot area, destroy it. #678, #820
+                if (dataLabel && (!labelEnabled || !defined(labelText))) {
+                    point.dataLabel = point.dataLabel.destroy();
+                    if (point.dataLabels) {
+                        // Remove point.dataLabels if this was the last one
+                        if (point.dataLabels.length === 1) {
+                            delete point.dataLabels;
+                        } else {
+                            delete point.dataLabels[i];
+                        }
+                    }
+                    if (!i) {
+                        delete point.dataLabel;
+                    }
+                    if (connector) {
+                        point.connector = point.connector.destroy();
+                        if (point.connectors) {
+                            // Remove point.connectors if this was the last one
+                            if (point.connectors.length === 1) {
+                                delete point.connectors;
+                            } else {
+                                delete point.connectors[i];
+                            }
+                        }
+                    }
+
+                // Individual labels are disabled if the are explicitly disabled
+                // in the point options, or if they fall outside the plot area.
+                } else if (labelEnabled && defined(labelText)) {
+
+                    if (!dataLabel) {
+                        // Create new label element
+                        point.dataLabels = point.dataLabels || [];
+                        dataLabel = point.dataLabels[i] = rotation ?
+
+                            // Labels don't rotate, use text element
+                            renderer.text(labelText, 0, -9999)
+                                .addClass('highcharts-data-label') :
+
+                            // We can use label
+                            renderer.label(
+                                labelText,
                                 0,
                                 -9999,
-                                options.useHTML
-                            )
-                            .addClass('highcharts-data-label') :
+                                labelOptions.shape,
+                                null,
+                                null,
+                                labelOptions.useHTML,
+                                null,
+                                'data-label'
+                            );
+
+                        // Store for backwards compatibility
+                        if (!i) {
+                            point.dataLabel = dataLabel;
+                        }
 
-                        renderer.label(
-                            str,
-                            0,
-                            -9999,
-                            options.shape,
-                            null,
-                            null,
-                            options.useHTML,
-                            null,
-                            'data-label'
+                        dataLabel.addClass(
+                            ' highcharts-data-label-color-' + point.colorIndex +
+                            ' ' + (labelOptions.className || '') +
+                            (   // #3398
+                                labelOptions.useHTML ?
+                                    ' highcharts-tracker' :
+                                    ''
+                            )
                         );
+                    } else {
+                        // Use old element and just update text
+                        attr.text = labelText;
+                    }
 
-                    dataLabel.addClass(
-                        ' highcharts-data-label-color-' + point.colorIndex +
-                        ' ' + (options.className || '') +
-                        (options.useHTML ? ' highcharts-tracker' : '') // #3398
+                    // Store data label options for later access
+                    dataLabel.options = labelOptions;
+
+                    dataLabel.attr(attr);
+                    
+                    // Styles must be applied before add in order to read text
+                    // bounding box
+                    dataLabel.css(style).shadow(labelOptions.shadow);
+                    
+
+                    if (!dataLabel.added) {
+                        dataLabel.add(dataLabelsGroup);
+                    }
+
+                    // Now the data label is created and placed at 0,0, so we
+                    // need to align it
+                    series.alignDataLabel(
+                        point, dataLabel, labelOptions, null, isNew
                     );
-                } else {
-                    attr.text = str;
-                }
-                dataLabel.attr(attr);
-                
-                // Styles must be applied before add in order to read text
-                // bounding box
-                dataLabel.css(style).shadow(options.shadow);
-                
-
-                if (!dataLabel.added) {
-                    dataLabel.add(dataLabelsGroup);
                 }
-                // Now the data label is created and placed at 0,0, so we need
-                // to align it
-                series.alignDataLabel(point, dataLabel, options, null, isNew);
-            }
+            });
         });
     }
 
@@ -452,19 +498,18 @@ Series.prototype.drawDataLabels = function () {
 /**
  * Align each individual data label.
  *
+ * @private
  * @function Highcharts.Series#alignDataLabel
  *
- * @param  {Highcharts.Point} point
+ * @param {Highcharts.Point} point
  *
- * @param  {Highcharts.SVGElement} dataLabel
+ * @param {Highcharts.SVGElement} dataLabel
  *
- * @param  {Highcharts.PlotSeriesDataLabelsOptions} options
+ * @param {Highcharts.PlotSeriesDataLabelsOptions} options
  *
- * @param  {Highcharts.BBoxObject} alignTo
+ * @param {Highcharts.BBoxObject} alignTo
  *
- * @param  {boolean} isNew
- *
- * @return {void}
+ * @param {boolean} isNew
  */
 Series.prototype.alignDataLabel = function (
     point,
@@ -613,17 +658,18 @@ Series.prototype.alignDataLabel = function (
  * If data labels fall partly outside the plot area, align them back in, in a
  * way that doesn't hide the point.
  *
+ * @private
  * @function Highcharts.Series#justifyDataLabel
  *
- * @param  {Highcharts.SVGElement} dataLabel
+ * @param {Highcharts.SVGElement} dataLabel
  *
- * @param  {Highcharts.PlotSeriesDataLabelsOptions} options
+ * @param {Highcharts.PlotSeriesDataLabelsOptions} options
  *
- * @param  {Highcharts.DataLabelAlignObject} alignAttr
+ * @param {*} alignAttr
  *
- * @param  {Highcharts.BBoxObject} bBox
+ * @param {Highcharts.BBoxObject} bBox
  *
- * @param  {boolean} isNew
+ * @param {boolean} isNew
  *
  * @return {boolean}
  */
@@ -698,9 +744,8 @@ if (seriesTypes.pie) {
     /**
      * Override the base drawDataLabels method by pie specific functionality
      *
+     * @private
      * @function Highcharts.seriesTypes.pie#drawDataLabels
-     *
-     * @return {void}
      */
     seriesTypes.pie.prototype.drawDataLabels = function () {
         var series = this,
@@ -790,6 +835,12 @@ if (seriesTypes.pie) {
                     
                 } else {
                     point.dataLabel = point.dataLabel.destroy();
+                    // Workaround to make pies destroy multiple datalabels
+                    // correctly. This logic needs rewriting to support multiple
+                    // datalabels fully.
+                    if (point.dataLabels && point.dataLabels.length === 1) {
+                        delete point.dataLabels;
+                    }
                 }
             }
         });
@@ -1035,9 +1086,10 @@ if (seriesTypes.pie) {
      * Extendable method for getting the path of the connector between the data
      * label and the pie slice.
      *
+     * @private
      * @function Highcharts.seriesTypes.pie#connectorPath
      *
-     * @param  {Highcharts.DataLabelPiePosObject} labelPos
+     * @param {*} labelPos
      *
      * @return {Highcharts.PathObject}
      */
@@ -1069,9 +1121,8 @@ if (seriesTypes.pie) {
      * Perform the final placement of the data labels after we have verified
      * that they fall within the plot area.
      *
+     * @private
      * @function Highcharts.seriesTypes.pie#placeDataLabels
-     *
-     * @return {void}
      */
     seriesTypes.pie.prototype.placeDataLabels = function () {
         each(this.points, function (point) {
@@ -1115,9 +1166,10 @@ if (seriesTypes.pie) {
      * translation and data label positioning to keep them inside the plot area.
      * Returns true when data labels are ready to draw.
      *
+     * @private
      * @function Highcharts.seriesTypes.pie#verifyDataLabelOverflow
      *
-     * @param  {boolean} overflow
+     * @param {boolean} overflow
      *
      * @return {boolean}
      */
@@ -1195,19 +1247,18 @@ if (seriesTypes.column) {
      * Override the basic data label alignment by adjusting for the position of
      * the column.
      *
+     * @private
      * @function Highcharts.seriesTypes.column#alignDataLabel
      *
-     * @param  {Highcharts.Point} point
-     *
-     * @param  {Highcharts.SVGElement} dataLabel
+     * @param {Highcharts.Point} point
      *
-     * @param  {Highcharts.PlotSeriesDataLabelsOptions} options
+     * @param {Highcharts.SVGElement} dataLabel
      *
-     * @param  {Highcharts.BBoxObject} alignTo
+     * @param {Highcharts.PlotSeriesDataLabelsOptions} options
      *
-     * @param  {boolean} isNew
+     * @param {Highcharts.BBoxObject} alignTo
      *
-     * @return {void}
+     * @param {boolean} isNew
      */
     seriesTypes.column.prototype.alignDataLabel = function (
         point,
@@ -1286,7 +1337,7 @@ if (seriesTypes.column) {
 
         // If label was justified and we have contrast, set it:
         if (point.isLabelJustified && point.contrastColor) {
-            point.dataLabel.css({
+            dataLabel.css({
                 color: point.contrastColor
             });
         }