highcharts 6.1.4 → 6.2.0

package/js/es-modules/parts/ScatterSeries.js

@@ -1,42 +1,60 @@
 /**
- * (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 Series = H.Series,
     seriesType = H.seriesType;
 
 /**
- * A scatter plot uses cartesian coordinates to display values for two variables
- * for a set of data.
+ * Scatter series type.
+ *
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.scatter
+ *
+ * @augments Highcharts.Series
+ */
+seriesType('scatter', 'line'
+
+/**
+ * A scatter plot uses cartesian coordinates to display values for two
+ * variables for a set of data.
+ *
+ * @sample {highcharts} highcharts/demo/scatter/
+ *         Scatter plot
  *
- * @sample       {highcharts} highcharts/demo/scatter/
- *               Scatter plot
- * @extends      {plotOptions.line}
+ * @extends      plotOptions.line
  * @excluding    pointPlacement, shadow
  * @product      highcharts highstock
  * @optionparent plotOptions.scatter
  */
-seriesType('scatter', 'line', {
+, {
 
     /**
      * The width of the line connecting the data points.
      *
-     * @sample  {highcharts} highcharts/plotoptions/scatter-linewidth-none/
-     *          0 by default
-     * @sample  {highcharts} highcharts/plotoptions/scatter-linewidth-1/
-     *          1px
+     * @sample {highcharts} highcharts/plotoptions/scatter-linewidth-none/
+     *         0 by default
+     * @sample {highcharts} highcharts/plotoptions/scatter-linewidth-1/
+     *         1px
+     *
      * @product highcharts highstock
      */
     lineWidth: 0,
 
     findNearestPointBy: 'xy',
+
     marker: {
+
         enabled: true // Overrides auto-enabling in line series (#3647)
     },
 
@@ -49,7 +67,7 @@ seriesType('scatter', 'line', {
      * is false and `tooltip.shared` is false, the tooltip will be hidden
      * when moving the mouse between series.
      *
-     * @type      {Boolean}
+     * @type      {boolean}
      * @default   false
      * @product   highcharts highstock
      * @apioption plotOptions.scatter.stickyTracking
@@ -66,13 +84,21 @@ seriesType('scatter', 'line', {
      * @product highcharts highstock
      */
     tooltip: {
+
         
 
+        /**
+         * @default ● {series.name}
+         */
         headerFormat:
             '<span class="highcharts-color-{point.colorIndex}">\u25CF</span> ' +
             '<span class="highcharts-header"> {series.name}</span><br/>',
+
         
 
+        /**
+         * @default x: {point.x} y: {point.y}
+         */
         pointFormat: 'x: <b>{point.x}</b><br/>y: <b>{point.y}</b><br/>'
     }
 
@@ -83,6 +109,11 @@ seriesType('scatter', 'line', {
     noSharedTooltip: true,
     trackerGroups: ['group', 'markerGroup', 'dataLabelsGroup'],
     takeOrdinalPosition: false, // #2342
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.scatter#drawGraph
+     */
     drawGraph: function () {
         if (this.options.lineWidth) {
             Series.prototype.drawGraph.call(this);
@@ -94,9 +125,8 @@ seriesType('scatter', 'line', {
  * A `scatter` series. If the [type](#series.scatter.type) option is
  * not specified, it is inherited from [chart.type](#chart.type).
  *
- * @type      {Object}
  * @extends   series,plotOptions.scatter
- * @excluding dataParser,dataURL
+ * @excluding dataParser, dataURL
  * @product   highcharts highstock
  * @apioption series.scatter
  */
@@ -146,18 +176,19 @@ seriesType('scatter', 'line', {
  *     }]
  *  ```
  *
- * @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.scatter.data
  */

package/js/es-modules/parts/ScrollablePlotArea.js

@@ -6,7 +6,9 @@
  * Highcharts feature to make the Y axis stay fixed when scrolling the chart
  * horizontally on mobile devices. Supports left and right side axes.
  */
+
 'use strict';
+
 import H from './Globals.js';
 
 var addEvent = H.addEvent,
@@ -20,11 +22,11 @@ var addEvent = H.addEvent,
  * This scrollbar provides smooth scrolling for the contents of the plot area,
  * whereas the title, legend and axes are fixed.
  *
- * @type    {Object}
- * @sample  {highcharts} highcharts/chart/scrollable-plotarea
- *          Scrollable plot area
- * @since   6.1.0
- * @product highcharts
+ * @sample {highcharts} highcharts/chart/scrollable-plotarea
+ *         Scrollable plot area
+ *
+ * @since     6.1.0
+ * @product   highcharts gantt
  * @apioption chart.scrollablePlotArea
  */
 
@@ -32,7 +34,7 @@ var addEvent = H.addEvent,
  * The minimum width for the plot area. If it gets smaller than this, the plot
  * area will become scrollable.
  *
- * @type    {Number}
+ * @type      {number}
  * @apioption chart.scrollablePlotArea.minWidth
  */
 
@@ -41,7 +43,7 @@ var addEvent = H.addEvent,
  * 1, where 0 aligns the plot area to the left and 1 aligns it to the right.
  * Typically we would use 1 if the chart has right aligned Y axes.
  *
- * @type    {Number}
+ * @type      {number}
  * @apioption chart.scrollablePlotArea.scrollPositionX
  */
 
@@ -105,6 +107,10 @@ addEvent(Chart, 'render', function () {
     }
 });
 
+/**
+ * @private
+ * @function Highcharts.Chart#setUpScrolling
+ */
 Chart.prototype.setUpScrolling = function () {
 
     // Add the necessary divs to provide scrolling
@@ -126,6 +132,10 @@ Chart.prototype.setUpScrolling = function () {
     this.setUpScrolling = null;
 };
 
+/**
+ * @private
+ * @function Highcharts.Chart#applyFixed
+ */
 Chart.prototype.applyFixed = function () {
     var container = this.container,
         fixedRenderer,

package/js/es-modules/parts/Scrollbar.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -105,6 +105,9 @@ var defaultScrollbarOptions = {
      * @type       {boolean}
      * @since      1.3
      * @product    highstock
+     *
+     * @sample     stock/scrollbar/liveredraw Setting live redraw to false
+     *
      * @apioption  scrollbar.liveRedraw
      */
     liveRedraw: undefined,
@@ -864,7 +867,11 @@ Scrollbar.prototype = {
 addEvent(Axis, 'afterInit', function () {
     var axis = this;
 
-    if (axis.options.scrollbar && axis.options.scrollbar.enabled) {
+    if (
+        axis.options &&
+        axis.options.scrollbar &&
+        axis.options.scrollbar.enabled
+    ) {
         // Predefined options:
         axis.options.scrollbar.vertical = !axis.horiz;
         axis.options.startOnTick = axis.options.endOnTick = false;

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

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -422,7 +422,7 @@ H.Series = H.seriesType('line', null
      * @type      {boolean}
      * @default   false
      * @since     4.1.6
-     * @product   highcharts highstock
+     * @product   highcharts highstock gantt
      * @apioption plotOptions.series.getExtremesFromAll
      */
 
@@ -447,6 +447,7 @@ H.Series = H.seriesType('line', null
      * The line cap used for line ends and line joins on the graph.
      *
      * @type       {string}
+     * @default    round
      * @product    highcharts highstock
      * @validvalue ["round", "square"]
      * @apioption  plotOptions.series.linecap
@@ -463,7 +464,7 @@ H.Series = H.seriesType('line', null
      *
      * @type      {string}
      * @since     3.0
-     * @product   highcharts highstock
+     * @product   highcharts highstock gantt
      * @apioption plotOptions.series.linkedTo
      */
 
@@ -542,7 +543,7 @@ H.Series = H.seriesType('line', null
      *
      * @type      {number}
      * @default   1
-     * @product   highcharts highstock
+     * @product   highcharts highstock gantt
      * @apioption plotOptions.series.pointInterval
      */
 
@@ -564,7 +565,7 @@ H.Series = H.seriesType('line', null
      *
      * @type       {string}
      * @since      4.1.0
-     * @product    highcharts highstock
+     * @product    highcharts highstock gantt
      * @validvalue ["day", "month", "year"]
      * @apioption  plotOptions.series.pointIntervalUnit
      */
@@ -589,6 +590,10 @@ H.Series = H.seriesType('line', null
      * #plotOptions.series.pointRange) to work. For column series this is
      * computed, but for line-type series it needs to be set.
      *
+     * For the `xrange` series type and gantt charts, if the Y axis is a
+     * category axis, the `pointPlacement` applies to the Y axis rather than
+     * the (typically datetime) X axis.
+     *
      * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
      *
      * @see [xAxis.tickmarkPlacement](#xAxis.tickmarkPlacement)
@@ -600,7 +605,7 @@ H.Series = H.seriesType('line', null
      *
      * @type      {string|number}
      * @since     2.3.0
-     * @product   highcharts highstock
+     * @product   highcharts highstock gantt
      * @apioption plotOptions.series.pointPlacement
      */
 
@@ -618,7 +623,7 @@ H.Series = H.seriesType('line', null
      *
      * @type      {number}
      * @default   0
-     * @product   highcharts highstock
+     * @product   highcharts highstock gantt
      * @apioption plotOptions.series.pointStart
      */
 
@@ -1244,9 +1249,17 @@ H.Series = H.seriesType('line', null
     /**
      * Options for the series data labels, appearing next to each data point.
      *
+     * Since v6.2.0, multiple data labels can be applied to each single point by
+     * defining them as an array of configs.
+     *
      * In styled mode, the data labels can be styled with the
      * `.highcharts-data-label-box` and `.highcharts-data-label` class names
      * ([see example](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/css/series-datalabels)).
+     *
+     * @sample highcharts/plotoptions/series-datalabels-enabled
+     *         Data labels enabled
+     * @sample highcharts/plotoptions/series-datalabels-multiple
+     *         Multiple data labels on a bar series
      */
     dataLabels: {
 
@@ -1368,7 +1381,7 @@ H.Series = H.seriesType('line', null
          * @type      {boolean}
          * @default   true
          * @since     4.0
-         * @product   highcharts highstock
+         * @product   highcharts highstock gantt
          * @apioption plotOptions.series.dataLabels.defer
          */
 
@@ -1830,7 +1843,7 @@ H.Series = H.seriesType('line', null
      * data checking and indexing in long series. Set it to `0` disable.
      *
      * @since   2.2
-     * @product highcharts highstock
+     * @product highcharts highstock gantt
      */
     turboThreshold: 1000,
 

package/js/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
  */
@@ -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/js/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,
@@ -110,6 +135,13 @@ H.StackItem.prototype = {
     /**
      * 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,
@@ -151,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,
@@ -175,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;
@@ -200,7 +256,8 @@ Chart.prototype.getStacks = function () {
 /**
  * Build the stacks from top down
  *
- * @ignore
+ * @private
+ * @function Highcharts.Axis#buildStacks
  */
 Axis.prototype.buildStacks = function () {
     var axisSeries = this.series,
@@ -221,6 +278,10 @@ Axis.prototype.buildStacks = function () {
     }
 };
 
+/**
+ * @private
+ * @function Highcharts.Axis#renderStackTotals
+ */
 Axis.prototype.renderStackTotals = function () {
     var axis = this,
         chart = axis.chart,
@@ -254,7 +315,8 @@ Axis.prototype.renderStackTotals = function () {
 /**
  * Set all the stacks to initial states and destroy unused ones.
  *
- * @ignore
+ * @private
+ * @function Highcharts.Axis#resetStacks
  */
 Axis.prototype.resetStacks = function () {
     var axis = this,
@@ -277,6 +339,10 @@ Axis.prototype.resetStacks = function () {
     }
 };
 
+/**
+ * @private
+ * @function Highcharts.Axis#cleanStacks
+ */
 Axis.prototype.cleanStacks = function () {
     var stacks;
 
@@ -299,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 &&
@@ -437,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,
@@ -473,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;
@@ -484,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)