highcharts 6.1.1 → 6.2.0

package/es-modules/parts/SplineSeries.js

@@ -1,40 +1,62 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
+
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
 import './Options.js';
 import './Series.js';
+
 var pick = H.pick,
     seriesType = H.seriesType;
 
 /**
- * A spline series is a special type of line series, where the segments between
- * the data points are smoothed.
+ * Spline series type.
  *
- * @sample    {highcharts} highcharts/demo/spline-irregular-time/
- *            Spline chart
- * @sample    {highstock} stock/demo/spline/
- *            Spline chart
- * @extends   plotOptions.series
- * @excluding step
- * @product   highcharts highstock
- * @apioption plotOptions.spline
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.spline
+ *
+ * @augments Highcarts.Series
  */
+seriesType('spline', 'line'
 
 /**
- * Spline series type.
+ * A spline series is a special type of line series, where the segments
+ * between the data points are smoothed.
+ *
+ * @sample {highcharts} highcharts/demo/spline-irregular-time/
+ *         Spline chart
+ * @sample {highstock} stock/demo/spline/
+ *         Spline chart
  *
- * @constructor seriesTypes.spline
- * @extends     {Series}
+ * @extends      plotOptions.series
+ * @excluding    step
+ * @product      highcharts highstock
+ * @optionparent plotOptions.spline
  */
-seriesType('spline', 'line', {}, /** @lends seriesTypes.spline.prototype */ {
+, {
+
+}, /** @lends seriesTypes.spline.prototype */ {
+
     /**
      * Get the spline segment from a given point's previous neighbour to the
-     * given point
+     * given point.
+     *
+     * @private
+     * @function Highcharts.seriesTypes.spline#getPointSpline
+     *
+     * @param {Array<Highcharts.Point>}
+     *
+     * @param {Highcharts.Point} point
+     *
+     * @param {number} i
+     *
+     * @return {Highcharts.SVGPathArray}
      */
     getPointSpline: function (points, point, i) {
         var
@@ -175,9 +197,8 @@ seriesType('spline', 'line', {}, /** @lends seriesTypes.spline.prototype */ {
  * A `spline` series. If the [type](#series.spline.type) option is
  * not specified, it is inherited from [chart.type](#chart.type).
  *
- * @type      {Object}
  * @extends   series,plotOptions.spline
- * @excluding dataParser,dataURL,step
+ * @excluding dataParser, dataURL, step
  * @product   highcharts highstock
  * @apioption series.spline
  */
@@ -208,8 +229,8 @@ seriesType('spline', 'line', {}, /** @lends seriesTypes.spline.prototype */ {
  *     ]
  *  ```
  *
- * 3.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 3.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.spline.turboThreshold),
  * this option is not available.
  *
@@ -227,18 +248,19 @@ seriesType('spline', 'line', {}, /** @lends seriesTypes.spline.prototype */ {
  *     }]
  *  ```
  *
- * @type      {Array<Object|Array|Number>}
+ * @sample {highcharts} highcharts/chart/reflow-true/
+ *         Numerical values
+ * @sample {highcharts} highcharts/series/data-array-of-arrays/
+ *         Arrays of numeric x and y
+ * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
+ *         Arrays of datetime x and y
+ * @sample {highcharts} highcharts/series/data-array-of-name-value/
+ *         Arrays of point.name and y
+ * @sample {highcharts} highcharts/series/data-array-of-objects/
+ *         Config objects
+ *
+ * @type      {Array<number|Array<number>|*>}
  * @extends   series.line.data
- * @sample    {highcharts} highcharts/chart/reflow-true/
- *            Numerical values
- * @sample    {highcharts} highcharts/series/data-array-of-arrays/
- *            Arrays of numeric x and y
- * @sample    {highcharts} highcharts/series/data-array-of-arrays-datetime/
- *            Arrays of datetime x and y
- * @sample    {highcharts} highcharts/series/data-array-of-name-value/
- *            Arrays of point.name and y
- * @sample    {highcharts} highcharts/series/data-array-of-objects/
- *            Config objects
  * @product   highcharts highstock
  * @apioption series.spline.data
  */

package/es-modules/parts/Stacking.js

@@ -1,14 +1,17 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
+
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
 import './Axis.js';
 import './Chart.js';
 import './Series.js';
+
 var Axis = H.Axis,
     Chart = H.Chart,
     correctFloat = H.correctFloat,
@@ -24,7 +27,19 @@ var Axis = H.Axis,
  * The class for stacks. Each stack, on a specific X value and either negative
  * or positive, has its own stack item.
  *
+ * @private
  * @class
+ * @name Highcharts.StackItem
+ *
+ * @param {Highcharts.Axis} axis
+ *
+ * @param {Highcharts.Options} options
+ *
+ * @param {boolean} isNegative
+ *
+ * @param {number} x
+ *
+ * @param {string|*} stackOption
  */
 H.StackItem = function (axis, options, isNegative, x, stackOption) {
 
@@ -71,12 +86,22 @@ H.StackItem = function (axis, options, isNegative, x, stackOption) {
 };
 
 H.StackItem.prototype = {
+
+    /**
+     * @private
+     * @function Highcharts.StackItem#destroy
+     */
     destroy: function () {
         destroyObjectProperties(this, this.axis);
     },
 
     /**
      * Renders the stack total label and adds it to the stack label group.
+     *
+     * @private
+     * @function Highcharts.StackItem#render
+     *
+     * @param {Highcharts.SVGElement} group
      */
     render: function (group) {
         var chart = this.axis.chart,
@@ -102,11 +127,21 @@ H.StackItem.prototype = {
                     })
                     .add(group); // add to the labels-group
         }
+
+        // Rank it higher than data labels (#8742)
+        this.label.labelrank = chart.plotHeight;
     },
 
     /**
      * Sets the offset that the stack has from the x value and repositions the
      * label.
+     *
+     * @private
+     * @function Highcarts.StackItem#setOffset
+     *
+     * @param {number} xOffset
+     *
+     * @param {number} xWidth
      */
     setOffset: function (xOffset, xWidth) {
         var stackItem = this,
@@ -121,9 +156,9 @@ H.StackItem.prototype = {
                 1
             ),
             yZero = axis.translate(0), // stack origin
-            h = Math.abs(y - yZero), // stack height
+            h = defined(y) && Math.abs(y - yZero), // stack height
             x = chart.xAxis[0].translate(stackItem.x) + xOffset, // x position
-            stackBox = stackItem.getStackBox(
+            stackBox = defined(y) && stackItem.getStackBox(
                 chart,
                 stackItem,
                 x,
@@ -135,7 +170,7 @@ H.StackItem.prototype = {
             label = stackItem.label,
             alignAttr;
 
-        if (label) {
+        if (label && stackBox) {
             // Align the label to the box
             label.align(stackItem.alignOptions, null, stackBox);
 
@@ -148,6 +183,27 @@ H.StackItem.prototype = {
                 ) ? 'show' : 'hide'](true);
         }
     },
+
+    /**
+     * @private
+     * @function Highcharts.StackItem#getStackBox
+     *
+     * @param {Highcharts.Chart} chart
+     *
+     * @param {Highcharts.StackItem} stackItem
+     *
+     * @param {number} x
+     *
+     * @param {number} y
+     *
+     * @param {number} xWidth
+     *
+     * @param {number} h
+     *
+     * @param {Highcharts.Axis} axis
+     *
+     * @return {*}
+     */
     getStackBox: function (chart, stackItem, x, y, xWidth, h, axis) {
         var reversed = stackItem.axis.reversed,
             inverted = chart.inverted,
@@ -172,6 +228,9 @@ H.StackItem.prototype = {
 
 /**
  * Generate stacks for each series and calculate stacks total values
+ *
+ * @private
+ * @function Highcharts.Chart#getStacks
  */
 Chart.prototype.getStacks = function () {
     var chart = this;
@@ -196,6 +255,9 @@ Chart.prototype.getStacks = function () {
 
 /**
  * Build the stacks from top down
+ *
+ * @private
+ * @function Highcharts.Axis#buildStacks
  */
 Axis.prototype.buildStacks = function () {
     var axisSeries = this.series,
@@ -216,6 +278,10 @@ Axis.prototype.buildStacks = function () {
     }
 };
 
+/**
+ * @private
+ * @function Highcharts.Axis#renderStackTotals
+ */
 Axis.prototype.renderStackTotals = function () {
     var axis = this,
         chart = axis.chart,
@@ -248,6 +314,9 @@ Axis.prototype.renderStackTotals = function () {
 
 /**
  * Set all the stacks to initial states and destroy unused ones.
+ *
+ * @private
+ * @function Highcharts.Axis#resetStacks
  */
 Axis.prototype.resetStacks = function () {
     var axis = this,
@@ -270,6 +339,10 @@ Axis.prototype.resetStacks = function () {
     }
 };
 
+/**
+ * @private
+ * @function Highcharts.Axis#cleanStacks
+ */
 Axis.prototype.cleanStacks = function () {
     var stacks;
 
@@ -292,6 +365,9 @@ Axis.prototype.cleanStacks = function () {
 
 /**
  * Adds series' points value to corresponding stack
+ *
+ * @private
+ * @function Highcharts.Series#setStackedPoints
  */
 Series.prototype.setStackedPoints = function () {
     if (!this.options.stacking || (this.visible !== true &&
@@ -430,6 +506,9 @@ Series.prototype.setStackedPoints = function () {
 
 /**
  * Iterate over all stacks and compute the absolute values to percent
+ *
+ * @private
+ * @function Highcharts.Series#modifyStacks
  */
 Series.prototype.modifyStacks = function () {
     var series = this,
@@ -466,6 +545,15 @@ Series.prototype.modifyStacks = function () {
 
 /**
  * Modifier function for percent stacks. Blows up the stack to 100%.
+ *
+ * @private
+ * @function Highcharts.Series#percentStacker
+ *
+ * @param {Array<number>} pointExtremes
+ *
+ * @param {Highcharts.StackItem} stack
+ *
+ * @param {number} i
  */
 Series.prototype.percentStacker = function (pointExtremes, stack, i) {
     var totalFactor = stack.total ? 100 / stack.total : 0;
@@ -477,9 +565,22 @@ Series.prototype.percentStacker = function (pointExtremes, stack, i) {
 };
 
 /**
-* Get stack indicator, according to it's x-value, to determine points with the
-* same x-value
-*/
+ * Get stack indicator, according to it's x-value, to determine points with the
+ * same x-value
+ *
+ * @private
+ * @function Highcharts.Series#getStackIndicator
+ *
+ * @param {*} stackIndicator
+ *
+ * @param {number} x
+ *
+ * @param {number} index
+ *
+ * @param {string} key
+ *
+ * @return {*}
+ */
 Series.prototype.getStackIndicator = function (stackIndicator, x, index, key) {
     // Update stack indicator, when:
     // first point in a stack || x changed || stack type (negative vs positive)

package/es-modules/parts/StockChart.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -48,7 +48,8 @@ var addEvent = H.addEvent,
  * zero value in the visible range. The y axis will show percentage
  * or absolute change depending on whether `compare` is set to `"percent"`
  * or `"value"`. When this is applied to multiple series, it allows
- * comparing the development of the series against each other.
+ * comparing the development of the series against each other. Adds
+ * a `change` field to every point object.
  *
  * @type {String}
  * @see [compareBase](#plotOptions.series.compareBase),
@@ -62,7 +63,7 @@ var addEvent = H.addEvent,
  */
 
 /**
- * Defines if comparisson should start from the first point within the visible
+ * Defines if comparison should start from the first point within the visible
  * range or should start from the first point <b>before</b> the range.
  * In other words, this flag determines if first point within the visible range
  * will have 0% (`compareStart=true`) or should have been already calculated
@@ -401,7 +402,7 @@ wrap(Axis.prototype, 'getPlotLinePath', function (
             inArray(axis2, uniqueAxes) === -1 &&
             // Do not draw on axis which overlap completely. #5424
             !H.find(uniqueAxes, function (unique) {
-                return unique.pos === axis2.pos && unique.len && axis2.len;
+                return unique.pos === axis2.pos && unique.len === axis2.len;
             })
         ) {
             uniqueAxes.push(axis2);
@@ -419,7 +420,10 @@ wrap(Axis.prototype, 'getPlotLinePath', function (
                 x1 = x2 = Math.round(transVal + axis.transB);
 
                 // outside plot area
-                if (x1 < axisLeft || x1 > axisLeft + axis.width) {
+                if (
+                    force !== 'pass' &&
+                    (x1 < axisLeft || x1 > axisLeft + axis.width)
+                ) {
                     if (force) {
                         x1 = x2 = Math.min(
                             Math.max(axisLeft, x1),
@@ -442,7 +446,10 @@ wrap(Axis.prototype, 'getPlotLinePath', function (
                 y1 = y2 = Math.round(axisTop + axis.height - transVal);
 
                 // outside plot area
-                if (y1 < axisTop || y1 > axisTop + axis.height) {
+                if (
+                    force !== 'pass' &&
+                    (y1 < axisTop || y1 > axisTop + axis.height)
+                ) {
                     if (force) {
                         y1 = y2 = Math.min(
                             Math.max(axisTop, y1),
@@ -530,7 +537,18 @@ addEvent(Axis, 'afterDrawCrosshair', function (event) {
         offset = 0,
         // Use last available event (#5287)
         e = event.e || (this.cross && this.cross.e),
-        point = event.point;
+        point = event.point,
+        lin2log = this.lin2log,
+        min,
+        max;
+
+    if (this.isLog) {
+        min = lin2log(this.min);
+        max = lin2log(this.max);
+    } else {
+        min = this.min;
+        max = this.max;
+    }
 
     align = (horiz ? 'center' : opposite ?
         (this.labelAlign === 'right' ? 'right' : 'left') :
@@ -603,7 +621,7 @@ addEvent(Axis, 'afterDrawCrosshair', function (event) {
         x: posx,
         y: posy,
         // Crosshair should be rendered within Axis range (#7219)
-        visibility: value < this.min || value > this.max ? 'hidden' : 'visible'
+        visibility: value < min || value > max ? 'hidden' : 'visible'
     });
 
     crossBox = crossLabel.getBBox();