highcharts 6.1.4 → 6.2.0

package/es-modules/parts/AreaSeries.js

@@ -1,15 +1,18 @@
 /**
- * (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 './Color.js';
 import './Legend.js';
 import './Series.js';
 import './Options.js';
+
 var color = H.color,
     each = H.each,
     LegendSymbolMixin = H.LegendSymbolMixin,
@@ -21,25 +24,27 @@ var color = H.color,
 /**
  * Area series type.
  *
- * @ignore
- * @constructor Highcharts.seriesTypes.area
- * @implements  {Highcharts.Series}
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.area
+ *
+ * @augments Highcharts.Series
  */
-seriesType('area', 'line', {
+seriesType('area', 'line'
 
-    /**
-     * The area series type.
-     *
-     * @sample {highcharts} highcharts/demo/area-basic/
-     *         Area chart
-     * @sample {highstock} stock/demo/area/
-     *         Area chart
-     *
-     * @type          {*}
-     * @extends       plotOptions.line
-     * @product       highcharts highstock
-     * @optionparent  plotOptions.area
-     */
+/**
+ * The area series type.
+ *
+ * @sample {highcharts} highcharts/demo/area-basic/
+ *         Area chart
+ * @sample {highstock} stock/demo/area/
+ *         Area chart
+ *
+ * @extends      plotOptions.line
+ * @product      highcharts highstock
+ * @optionparent plotOptions.area
+ */
+, {
 
     /**
      * Fill color or gradient for the area. When `null`, the series' `color`
@@ -53,9 +58,9 @@ seriesType('area', 'line', {
      * @sample {highcharts} highcharts/plotoptions/area-fillcolor-gradient/
      *         Gradient
      *
-     * @type       {Highcharts.ColorString}
-     * @product    highcharts highstock
-     * @apioption  plotOptions.area.fillColor
+     * @type      {Highcharts.ColorString}
+     * @product   highcharts highstock
+     * @apioption plotOptions.area.fillColor
      */
 
     /**
@@ -71,11 +76,11 @@ seriesType('area', 'line', {
      * @sample {highcharts} highcharts/plotoptions/area-fillopacity/
      *         Automatic fill color and fill opacity of 0.1
      *
-     * @type       {number}
-     * @default    {highcharts} 0.75
-     * @default    {highstock} .75
-     * @product    highcharts highstock
-     * @apioption  plotOptions.area.fillOpacity
+     * @type      {number}
+     * @default   {highcharts} 0.75
+     * @default   {highstock} 0.75
+     * @product   highcharts highstock
+     * @apioption plotOptions.area.fillOpacity
      */
 
     /**
@@ -89,9 +94,9 @@ seriesType('area', 'line', {
      * @sample {highcharts} highcharts/plotoptions/area-linecolor/
      *         Dark gray line
      *
-     * @type       {Highcharts.ColorString}
-     * @product    highcharts highstock
-     * @apioption  plotOptions.area.lineColor
+     * @type      {Highcharts.ColorString}
+     * @product   highcharts highstock
+     * @apioption plotOptions.area.lineColor
      */
 
     /**
@@ -105,10 +110,10 @@ seriesType('area', 'line', {
      * @sample {highcharts} highcharts/css/series-negative-color/
      *         Negative color in styled mode
      *
-     * @type       {Highcharts.ColorString}
-     * @since      3.0
-     * @product    highcharts
-     * @apioption  plotOptions.area.negativeFillColor
+     * @type      {Highcharts.ColorString}
+     * @since     3.0
+     * @product   highcharts
+     * @apioption plotOptions.area.negativeFillColor
      */
 
     /**
@@ -118,11 +123,11 @@ seriesType('area', 'line', {
      * @sample {highcharts|highstock} highcharts/plotoptions/area-trackbyarea/
      *         Display the tooltip when the area is hovered
      *
-     * @type       {boolean}
-     * @default    false
-     * @since      1.1.6
-     * @product    highcharts highstock
-     * @apioption  plotOptions.area.trackByArea
+     * @type      {boolean}
+     * @default   false
+     * @since     1.1.6
+     * @product   highcharts highstock
+     * @apioption plotOptions.area.trackByArea
      */
 
     /**
@@ -134,10 +139,8 @@ seriesType('area', 'line', {
      * 3 will make the Y axis show negative values according to the `minPadding`
      * option. If `softThreshold` is `true`, the Y axis starts at 0.
      *
-     * @type       {boolean}
-     * @since      4.1.9
-     * @product    highcharts highstock
-     * @apioption  plotOptions.area.softThreshold
+     * @since   4.1.9
+     * @product highcharts highstock
      */
     softThreshold: false,
 
@@ -152,30 +155,30 @@ seriesType('area', 'line', {
      * * If `Infinity` or `-Infinity`, the area between the graph and the
      *   corresponing Y axis extreme is filled (since v6.1.0).
      *
-     * @sample  {highcharts} highcharts/plotoptions/area-threshold/
-     *          A threshold of 100
-     * @sample  {highcharts} highcharts/plotoptions/area-threshold-infinity/
-     *          A threshold of Infinity
+     * @sample {highcharts} highcharts/plotoptions/area-threshold/
+     *         A threshold of 100
+     * @sample {highcharts} highcharts/plotoptions/area-threshold-infinity/
+     *         A threshold of Infinity
      *
-     * @type       {number}
-     * @since      2.0
-     * @product    highcharts highstock
-     * @apioption  plotOptions.area.threshold
+     * @since   2.0
+     * @product highcharts highstock
      */
     threshold: 0
 
 
 }, /** @lends seriesTypes.area.prototype */ {
+
     singleStacks: false,
+
     /**
      * Return an array of stacked points, where null and missing points are
      * replaced by dummy points in order for gaps to be drawn correctly
      * in stacks.
      *
-     * @ignore
+     * @private
      * @function Highcharts.seriesTypes.area#getStackPoints
      *
-     * @param  {Array<Highcharts.Point>} points
+     * @param {Array<Highcharts.Point>} points
      *
      * @return {Array<*>}
      */
@@ -315,12 +318,12 @@ seriesType('area', 'line', {
     },
 
     /**
-     * @ignore
+     * @private
      * @function Highcharts.seriesTypes.area#getGraphPath
      *
-     * @param  {Array<Highcharts.Points>} points
+     * @param {Array<Highcharts.Point>} points
      *
-     * @return {Array<number|string>}
+     * @return {Highcharts.SVGPathArray}
      */
     getGraphPath: function (points) {
         var getGraphPath = Series.prototype.getGraphPath,
@@ -448,10 +451,8 @@ seriesType('area', 'line', {
      * function and adds the area. The areaPath is calculated in the
      * getSegmentPath method called from Series.prototype.drawGraph.
      *
-     * @ignore
+     * @private
      * @function Highcharts.seriesTypes.area#drawGraph
-     *
-     * @return {void}
      */
     drawGraph: function () {
 
@@ -524,11 +525,10 @@ seriesType('area', 'line', {
  * A `area` series. If the [type](#series.area.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).
  *
- * @type       {*}
- * @extends    series,plotOptions.area
- * @excluding  dataParser,dataURL
- * @product    highcharts highstock
- * @apioption  series.area
+ * @extends   series,plotOptions.area
+ * @excluding dataParser, dataURL
+ * @product   highcharts highstock
+ * @apioption series.area
  */
 
 /**
@@ -576,19 +576,19 @@ seriesType('area', 'line', {
  *     }]
  *  ```
  *
- * @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
+ * @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
- * @product    highcharts highstock
- * @apioption  series.area.data
+ * @type      {Array<number|Array<number>|*>}
+ * @extends   series.line.data
+ * @product   highcharts highstock
+ * @apioption series.area.data
  */

package/es-modules/parts/AreaSplineSeries.js

@@ -1,51 +1,87 @@
 /**
- * (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 './Legend.js';
 import './AreaSeries.js';
 import './SplineSeries.js';
+
 var areaProto = H.seriesTypes.area.prototype,
     defaultPlotOptions = H.defaultPlotOptions,
     LegendSymbolMixin = H.LegendSymbolMixin,
     seriesType = H.seriesType;
+
 /**
- * AreaSplineSeries object
- */
-/**
- * The area spline series is an area series where the graph between the points
- * is smoothed into a spline.
+ * AreaSpline series type.
  *
- * @extends   plotOptions.area
- * @excluding step
- * @sample    {highcharts} highcharts/demo/areaspline/ Area spline chart
- * @sample    {highstock} stock/demo/areaspline/ Area spline chart
- * @product   highcharts highstock
- * @apioption plotOptions.areaspline
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.areaspline
+ *
+ * @augments Highcharts.Series
  */
-seriesType('areaspline', 'spline', defaultPlotOptions.area, {
+seriesType('areaspline', 'spline',
+
+    /**
+     * The area spline series is an area series where the graph between the
+     * points is smoothed into a spline.
+     *
+     * @sample {highcharts} highcharts/demo/areaspline/
+     *         Area spline chart
+     * @sample {highstock} stock/demo/areaspline/
+     *         Area spline chart
+     *
+     * @extends   plotOptions.area
+     * @excluding step
+     * @product   highcharts highstock
+     * @apioption plotOptions.areaspline
+     */
+    defaultPlotOptions.area
+, {
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.areaspline#getStackPoints
+     */
     getStackPoints: areaProto.getStackPoints,
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.areaspline#getGraphPath
+     */
     getGraphPath: areaProto.getGraphPath,
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.areaspline#drawGraph
+     */
     drawGraph: areaProto.drawGraph,
+
+    /**
+     * @private
+     * @borrows Highcharts.LegendSymbolMixin#drawRectangle as Highcharts.seriesTypes.areaspline#drawLegendSymbol
+     */
     drawLegendSymbol: LegendSymbolMixin.drawRectangle
+
 });
+
 /**
  * A `areaspline` series. If the [type](#series.areaspline.type) option
  * is not specified, it is inherited from [chart.type](#chart.type).
  *
  *
- * @type      {Object}
  * @extends   series,plotOptions.areaspline
- * @excluding dataParser,dataURL
+ * @excluding dataParser, dataURL
  * @product   highcharts highstock
  * @apioption series.areaspline
  */
 
-
 /**
  * An array of data points for the series. For the `areaspline` series
  * type, points can be given in the following ways:
@@ -92,18 +128,19 @@ seriesType('areaspline', 'spline', defaultPlotOptions.area, {
  *     }]
  *  ```
  *
- * @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.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.areaspline.data
  */