highcharts 6.1.4 → 6.2.0

package/es-modules/parts/BarSeries.js

@@ -1,9 +1,11 @@
 /**
- * (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 './ColumnSeries.js';
@@ -11,31 +13,69 @@ import './ColumnSeries.js';
 var seriesType = H.seriesType;
 
 /**
- * The Bar series class
+ * Bar series type.
+ *
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.bar
+ *
+ * @augments Highcharts.Series
  */
-seriesType('bar', 'column', null, {
+seriesType('bar', 'column',
+
+    /**
+     * A bar series is a special type of column series where the columns are
+     * horizontal.
+     *
+     * @sample highcharts/demo/bar-basic/
+     *         Bar chart
+     *
+     * @extends   plotOptions.column
+     * @product   highcharts
+     * @apioption plotOptions.bar
+     */
+
+    /**
+     * Alignment of the data label relative to the data point.
+     *
+     * @sample {highcharts} highcharts/plotoptions/bar-datalabels-align-inside-bar/
+     *         Data labels inside the bar
+     *
+     * @type      {string}
+     * @default   left
+     * @product   highcharts
+     * @apioption plotOptions.bar.dataLabels.align
+     */
+
+    /**
+     * The x position of the data label relative to the data point.
+     *
+     * @sample {highcharts} highcharts/plotoptions/bar-datalabels-align-inside-bar/
+     *         Data labels inside the bar
+     *
+     * @type      {number}
+     * @default   5
+     * @product   highcharts
+     * @apioption plotOptions.bar.dataLabels.x
+     */
+
+    /**
+     * @ignore
+     */
+    null
+
+, {
     inverted: true
 });
-/**
- * A bar series is a special type of column series where the columns are
- * horizontal.
- *
- * @sample       highcharts/demo/bar-basic/
- *               Bar chart
- * @extends      {plotOptions.column}
- * @product      highcharts
- * @optionparent plotOptions.bar
- */
 
 
 /**
  * A `bar` series. If the [type](#series.bar.type) option is not specified,
  * it is inherited from [chart.type](#chart.type).
  *
- * @type      {Object}
  * @extends   series,plotOptions.bar
- * @excluding connectNulls,dashStyle,dataParser,dataURL,gapSize,gapUnit,linecap,
- *            lineWidth,marker,connectEnds,step
+ * @excluding connectNulls, dashStyle, dataParser, dataURL, gapSize, gapUnit,
+ *            linecap, lineWidth, marker, connectEnds, step
  * @product   highcharts
  * @apioption series.bar
  */
@@ -85,18 +125,19 @@ seriesType('bar', 'column', null, {
  *     }]
  *  ```
  *
- * @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|string|Date>|*>}
  * @extends   series.column.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
  * @apioption series.bar.data
  */
@@ -112,27 +153,3 @@ seriesType('bar', 'column', null, {
  * @product   highcharts highstock
  * @apioption series.bar.states.select
  */
-
-/**
- * Alignment of the data label relative to the data point.
- *
- * @type      {String}
- * @sample    {highcharts}
- *            highcharts/plotoptions/bar-datalabels-align-inside-bar/
- *            Data labels inside the bar
- * @default   left
- * @product   highcharts
- * @apioption plotOptions.bar.dataLabels.align
- */
-
-/**
- * The x position of the data label relative to the data point.
- *
- * @type      {Number}
- * @sample    {highcharts}
- *            highcharts/plotoptions/bar-datalabels-align-inside-bar/
- *            Data labels inside the bar
- * @default   5
- * @product   highcharts
- * @apioption plotOptions.bar.dataLabels.x
- */

package/es-modules/parts/CandlestickSeries.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */

package/es-modules/parts/Chart.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -102,25 +102,13 @@ var addEvent = H.addEvent,
  * @class
  * @name Highcharts.Chart
  *
- * @param {Highcharts.Options} options
- *        The chart options structure.
- *
- * @param {Highcharts.ChartCallbackFunction|undefined} [callback]
- *        Function to run when the chart has loaded and and all external images
- *        are loaded. Defining a
- *        {@link https://api.highcharts.com/highcharts/chart.events.load|chart.event.load}
- *        handler is equivalent.
- *//**
- * @class
- * @name Highcharts.Chart
- *
- * @param {string|Highcharts.HTMLDOMElement} renderTo
+ * @param {string|Highcharts.HTMLDOMElement} [renderTo]
  *        The DOM element to render to, or its id.
  *
  * @param {Highcharts.Options} options
  *        The chart options structure.
  *
- * @param {Highcharts.ChartCallbackFunction|undefined} [callback]
+ * @param {Highcharts.ChartCallbackFunction} [callback]
  *        Function to run when the chart has loaded and and all external images
  *        are loaded. Defining a
  *        {@link https://api.highcharts.com/highcharts/chart.events.load|chart.event.load}
@@ -146,27 +134,13 @@ var Chart = H.Chart = function () {
  *
  * @function Highcharts.chart
  *
- * @param {Highcharts.Options} options
- *        The chart options structure.
- *
- * @param {Highcharts.ChartCallbackFunction|undefined} [callback]
- *        Function to run when the chart has loaded and and all external images
- *        are loaded. Defining a
- *        {@link https://api.highcharts.com/highcharts/chart.events.load|chart.event.load}
- *        handler is equivalent.
- *
- * @return {Highcharts.Chart}
- *         Returns the Chart object.
- *//**
- * @function Highcharts.chart
- *
- * @param {string|Highcharts.HTMLDOMElement} renderTo
+ * @param {string|Highcharts.HTMLDOMElement} [renderTo]
  *        The DOM element to render to, or its id.
  *
  * @param {Highcharts.Options} options
  *        The chart options structure.
  *
- * @param {Highcharts.ChartCallbackFunction|undefined} [callback]
+ * @param {Highcharts.ChartCallbackFunction} [callback]
  *        Function to run when the chart has loaded and and all external images
  *        are loaded. Defining a
  *        {@link https://api.highcharts.com/highcharts/chart.events.load|chart.event.load}
@@ -219,7 +193,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      * @param {Highcharts.Options} userOptions
      *        Custom options.
      *
-     * @param {Function|undefined} [callback]
+     * @param {Function} [callback]
      *        Function to run when the chart has loaded and and all external
      *        images are loaded.
      *
@@ -458,7 +432,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      *
      * @function Highcharts.Chart#redraw
      *
-     * @param {boolean|Highcharts.AnimationOptionsObject|undefined} [animation]
+     * @param {boolean|Highcharts.AnimationOptionsObject} [animation]
      *        If or how to apply animation to the redraw.
      *
      * @fires Highcharts.Chart#event:afterSetExtremes
@@ -568,6 +542,10 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
             // set axes scales
             each(axes, function (axis) {
                 axis.updateNames();
+                // Update categories in a Gantt chart
+                if (axis.updateYNames) {
+                    axis.updateYNames();
+                }
                 axis.setScale();
             });
         }
@@ -899,7 +877,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      * @private
      * @function Highcharts.Chart#layOutTitles
      *
-     * @param {boolean|undefined} [redraw=true]
+     * @param {boolean} [redraw=true]
      */
     layOutTitles: function (redraw) {
         var titleOffset = 0,
@@ -959,8 +937,6 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      * {@link Chart.chartHeight}.
      *
      * @function Highcharts.Chart#getChartSize
-     *
-     * @return {void}
      */
     getChartSize: function () {
         var chart = this,
@@ -1233,7 +1209,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      * @private
      * @function Highcharts.Chart#getMargins
      *
-     * @param  {boolean} skipAxes
+     * @param {boolean} skipAxes
      *
      * @fires Highcharts.Chart#event:getMargins
      */
@@ -1311,9 +1287,9 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      *
      * @function Highcharts.Chart#reflow
      *
-     * @param  {global.Event} e
-     *         Event arguments. Used primarily when the function is called
-     *         internally as a response to window resize.
+     * @param {global.Event} e
+     *        Event arguments. Used primarily when the function is called
+     *        internally as a response to window resize.
      */
     reflow: function (e) {
         var chart = this,
@@ -1363,7 +1339,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      * @private
      * @function Highcharts.Chart#setReflow
      *
-     * @param  {boolean} reflow
+     * @param {boolean} reflow
      */
     setReflow: function (reflow) {
 
@@ -1407,19 +1383,19 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      *
      * @function Highcharts.Chart#setSize
      *
-     * @param  {number|null|undefined} [width]
-     *         The new pixel width of the chart. Since v4.2.6, the argument can
-     *         be `undefined` in order to preserve the current value (when
-     *         setting height only), or `null` to adapt to the width of the
-     *         containing element.
+     * @param {number|null} [width]
+     *        The new pixel width of the chart. Since v4.2.6, the argument can
+     *        be `undefined` in order to preserve the current value (when
+     *        setting height only), or `null` to adapt to the width of the
+     *        containing element.
      *
-     * @param  {number|null|undefined} [height]
-     *         The new pixel height of the chart. Since v4.2.6, the argument can
-     *         be `undefined` in order to preserve the current value, or `null`
-     *         in order to adapt to the height of the containing element.
+     * @param {number|null} [height]
+     *        The new pixel height of the chart. Since v4.2.6, the argument can
+     *        be `undefined` in order to preserve the current value, or `null`
+     *        in order to adapt to the height of the containing element.
      *
-     * @param  {Highcharts.AnimationOptionsObject|undefined} [animation=true]
-     *         Whether and how to apply animation.
+     * @param {Highcharts.AnimationOptionsObject} [animation=true]
+     *        Whether and how to apply animation.
      *
      * @fires Highcharts.Chart#event:endResize
      * @fires Highcharts.Chart#event:resize
@@ -1494,7 +1470,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      * @private
      * @function Highcharts.Chart#setChartSize
      *
-     * @param  {boolean} skipAxes
+     * @param {boolean} skipAxes
      *
      * @fires Highcharts.Chart#event:afterSetChartSize
      */
@@ -2028,8 +2004,8 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
      *
      * @function Highcharts.Chart#addCredits
      *
-     * @param  {Highcharts.CreditsOptions} options
-     *         A configuration object for the new credits.
+     * @param {Highcharts.CreditsOptions} options
+     *        A configuration object for the new credits.
      */
     addCredits: function (credits) {
         var chart = this;

package/es-modules/parts/Color.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -15,8 +15,10 @@
  */
 
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
+
 var each = H.each,
     isNumber = H.isNumber,
     map = H.map,
@@ -26,8 +28,9 @@ var each = H.each,
 /**
  * Handle color operations. The object methods are chainable.
  *
- * @ignore
- * @class Highcharts.Color
+ * @private
+ * @class
+ * @name Highcharts.Color
  *
  * @param {Highcharts.ColorString} input
  *        The input color in either rbga or hex format
@@ -77,10 +80,8 @@ H.Color.prototype = {
      * @private
      * @function Highcharts.Color#init
      *
-     * @param  {Highcharts.ColorString} input
-     *         The input color in either rbga or hex format
-     *
-     * @return {void}
+     * @param {Highcharts.ColorString} input
+     *        The input color in either rbga or hex format
      */
     init: function (input) {
         var result,
@@ -154,8 +155,8 @@ H.Color.prototype = {
      *
      * @function Highcharts.Color#get
      *
-     * @param  {string} format
-     *         Possible values are 'a', 'rgb', undefined
+     * @param {string} format
+     *        Possible values are 'a', 'rgb', undefined
      *
      * @return {Highcharts.ColorString}
      *         This color as a string.
@@ -192,8 +193,8 @@ H.Color.prototype = {
      *
      * @function Highcharts.Color#brighten
      *
-     * @param  {number} alpha
-     *         The alpha value.
+     * @param {number} alpha
+     *        The alpha value.
      *
      * @return {Highcharts.ColorString}
      *         This color with modifications.
@@ -227,8 +228,8 @@ H.Color.prototype = {
      *
      * @function Highcharts.Color#setOpacity
      *
-     * @param  {number} alpha
-     *         Opacity between 0 and 1.
+     * @param {number} alpha
+     *        Opacity between 0 and 1.
      *
      * @return {Highcharts.ColorString}
      *         Color with modifications.
@@ -243,12 +244,12 @@ H.Color.prototype = {
      *
      * @function Highcharts.Color#tweenTo
      *
-     * @param  {Highcharts.Color} to
-     *         The color object to tween to.
+     * @param {Highcharts.Color} to
+     *        The color object to tween to.
      *
-     * @param  {number} pos
-     *         The intermediate position, where 0 is the from color (current
-     *         color item), and 1 is the `to` color.
+     * @param {number} pos
+     *        The intermediate position, where 0 is the from color (current
+     *        color item), and 1 is the `to` color.
      *
      * @return {Highcharts.ColorString}
      *         The intermediate color in rgba notation.
@@ -287,6 +288,16 @@ H.Color.prototype = {
         return ret;
     }
 };
+
+/**
+ * Creates a color instance out of a color string.
+ *
+ * @private
+ * @function Highcharts.color
+ *
+ * @param {Highcharts.ColorString} input
+ *        The input color in either rbga or hex format
+ */
 H.color = function (input) {
     return new H.Color(input);
 };