highcharts 10.2.0 → 10.2.1

package/es-modules/Stock/Indicators/DMI/DMIIndicator.js

@@ -264,6 +264,11 @@ SeriesRegistry.registerSeriesType('dmi', DMIIndicator);
  *
  * */
 export default DMIIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * The Directional Movement Index (DMI) indicator series.
  * If the [type](#series.dmi.type) option is not

package/es-modules/Stock/Indicators/DPO/DPOIndicator.js

@@ -25,7 +25,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge, correctFloat = U.correctFloat, pick = U.pick;
-/* eslint-disable valid-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 // Utils:
 /**
  * @private
@@ -54,12 +58,17 @@ function accumulatePoints(sum, yVal, i, index, subtract) {
 var DPOIndicator = /** @class */ (function (_super) {
     __extends(DPOIndicator, _super);
     function DPOIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
-        *
-        *   Properties
-        *
-        * */
+         *
+         *   Properties
+         *
+         * */
         _this.options = void 0;
         _this.data = void 0;
         _this.points = void 0;
@@ -70,9 +79,6 @@ var DPOIndicator = /** @class */ (function (_super) {
      *  Functions
      *
      * */
-    /**
-     * @lends Highcharts.Series#
-     */
     DPOIndicator.prototype.getValues = function (series, params) {
         var period = params.period, index = params.index, offset = Math.floor(period / 2 + 1), range = period + offset, xVal = series.xData || [], yVal = series.yData || [], yValLen = yVal.length, 
         // 0- date, 1- Detrended Price Oscillator
@@ -148,6 +154,11 @@ SeriesRegistry.registerSeriesType('dpo', DPOIndicator);
  *
  * */
 export default DPOIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A Detrended Price Oscillator. If the [type](#series.dpo.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/EMA/EMAIndicator.js

@@ -42,6 +42,11 @@ var correctFloat = U.correctFloat, isArray = U.isArray, merge = U.merge;
 var EMAIndicator = /** @class */ (function (_super) {
     __extends(EMAIndicator, _super);
     function EMAIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -142,6 +147,11 @@ SeriesRegistry.registerSeriesType('ema', EMAIndicator);
  *
  * */
 export default EMAIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `EMA` series. If the [type](#series.ema.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/IKH/IKHIndicator.js

@@ -28,7 +28,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var defined = U.defined, extend = U.extend, isArray = U.isArray, isNumber = U.isNumber, merge = U.merge, objectEach = U.objectEach;
-/* eslint-disable require-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 // Utils:
 function maxHigh(arr) {
     return arr.reduce(function (max, res) {
@@ -101,6 +105,7 @@ function drawSenkouSpan(opt) {
 // Data integrity in Ichimoku is different than default 'averages':
 // Point: [undefined, value, value, ...] is correct
 // Point: [undefined, undefined, undefined, ...] is incorrect
+// @todo compose
 H.approximations['ichimoku-averages'] = function () {
     var ret = [], isEmptyRange;
     [].forEach.call(arguments, function (arr, i) {
@@ -111,7 +116,11 @@ H.approximations['ichimoku-averages'] = function () {
     // sum method handle null (#7377)
     return isEmptyRange ? void 0 : ret;
 };
-/* eslint-enable require-jsdoc */
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The IKH series type.
  *
@@ -121,20 +130,20 @@ H.approximations['ichimoku-averages'] = function () {
  *
  * @augments Highcharts.Series
  */
-/* *
-*
-* Class
-*
-* */
 var IKHIndicator = /** @class */ (function (_super) {
     __extends(IKHIndicator, _super);
     function IKHIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
-        *
-        *  Properties
-        *
-        * */
+         *
+         *  Properties
+         *
+         * */
         _this.data = void 0;
         _this.options = void 0;
         _this.points = void 0;
@@ -145,10 +154,10 @@ var IKHIndicator = /** @class */ (function (_super) {
         return _this;
     }
     /* *
-    *
-    * Functions
-    *
-    * */
+     *
+     * Functions
+     *
+     * */
     IKHIndicator.prototype.init = function () {
         SeriesRegistry.seriesTypes.sma.prototype.init.apply(this, arguments);
         // Set default color for lines:
@@ -668,7 +677,17 @@ extend(IKHIndicator.prototype, {
     nameComponents: ['periodSenkouSpanB', 'period', 'periodTenkan']
 });
 SeriesRegistry.registerSeriesType('ikh', IKHIndicator);
+/* *
+ *
+ *  Default Export
+ *
+ * */
 export default IKHIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `IKH` series. If the [type](#series.ikh.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js

@@ -26,6 +26,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var correctFloat = U.correctFloat, extend = U.extend, merge = U.merge;
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The Keltner Channels series type.
  *
@@ -38,12 +43,27 @@ var correctFloat = U.correctFloat, extend = U.extend, merge = U.merge;
 var KeltnerChannelsIndicator = /** @class */ (function (_super) {
     __extends(KeltnerChannelsIndicator, _super);
     function KeltnerChannelsIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
+        /* *
+         *
+         *  Properties
+         *
+         * */
         _this.data = void 0;
         _this.options = void 0;
         _this.points = void 0;
         return _this;
     }
+    /* *
+     *
+     *  Functions
+     *
+     * */
     KeltnerChannelsIndicator.prototype.init = function () {
         SeriesRegistry.seriesTypes.sma.prototype.init.apply(this, arguments);
         // Set default color for lines:
@@ -201,6 +221,11 @@ SeriesRegistry.registerSeriesType('keltnerchannels', KeltnerChannelsIndicator);
  *
  * */
 export default KeltnerChannelsIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A Keltner Channels indicator. If the [type](#series.keltnerchannels.type)
  * option is not specified, it is inherited from[chart.type](#chart.type).

package/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js

@@ -23,9 +23,15 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import MultipleLinesComposition from '../MultipleLinesComposition.js';
 import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
-var _a = SeriesRegistry.seriesTypes, SMAIndicator = _a.sma, EMAIndicator = _a.ema;
+var EMAIndicator = SeriesRegistry.seriesTypes.ema;
+var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var correctFloat = U.correctFloat, error = U.error, extend = U.extend, isArray = U.isArray, merge = U.merge;
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The Klinger oscillator series type.
  *
@@ -258,6 +264,11 @@ SeriesRegistry.registerSeriesType('klinger', KlingerIndicator);
  *
  * */
 export default KlingerIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A Klinger oscillator. If the [type](#series.klinger.type)
  * option is not specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/LinearRegression/{LinearRegression.js → LinearRegressionIndicator.js}

@@ -29,7 +29,7 @@ import U from '../../../Core/Utilities.js';
 var isArray = U.isArray, extend = U.extend, merge = U.merge;
 /* *
  *
- * Class
+ *  Class
  *
  * */
 /**
@@ -44,6 +44,11 @@ var isArray = U.isArray, extend = U.extend, merge = U.merge;
 var LinearRegressionIndicator = /** @class */ (function (_super) {
     __extends(LinearRegressionIndicator, _super);
     function LinearRegressionIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -268,6 +273,11 @@ SeriesRegistry.registerSeriesType('linearRegression', LinearRegressionIndicator)
  *
  * */
 export default LinearRegressionIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A linear regression series. If the
  * [type](#series.linearregression.type) option is not specified, it is

package/es-modules/Stock/Indicators/LinearRegressionAngle/{LinearRegressionAngle.js → LinearRegressionAngleIndicator.js}

@@ -29,7 +29,7 @@ import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge;
 /* *
  *
- * Class
+ *  Class
  *
  * */
 /**
@@ -44,6 +44,11 @@ var extend = U.extend, merge = U.merge;
 var LinearRegressionAngleIndicator = /** @class */ (function (_super) {
     __extends(LinearRegressionAngleIndicator, _super);
     function LinearRegressionAngleIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -61,12 +66,12 @@ var LinearRegressionAngleIndicator = /** @class */ (function (_super) {
      *
      * */
     /**
-    * Convert a slope of a line to angle (in degrees) between
-    * the line and x axis
-    * @private
-    * @param {number} slope of the straight line function
-    * @return {number} angle in degrees
-    */
+     * Convert a slope of a line to angle (in degrees) between
+     * the line and x axis
+     * @private
+     * @param {number} slope of the straight line function
+     * @return {number} angle in degrees
+     */
     LinearRegressionAngleIndicator.prototype.slopeToAngle = function (slope) {
         return Math.atan(slope) * (180 / Math.PI); // rad to deg
     };

package/es-modules/Stock/Indicators/LinearRegressionIntercept/{LinearRegressionIntercept.js → LinearRegressionInterceptIndicator.js}

@@ -29,7 +29,7 @@ import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge;
 /* *
  *
- * Class
+ *  Class
  *
  * */
 /**
@@ -44,6 +44,11 @@ var extend = U.extend, merge = U.merge;
 var LinearRegressionInterceptIndicator = /** @class */ (function (_super) {
     __extends(LinearRegressionInterceptIndicator, _super);
     function LinearRegressionInterceptIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -90,6 +95,11 @@ SeriesRegistry.registerSeriesType('linearRegressionIntercept', LinearRegressionI
  *
  * */
 export default LinearRegressionInterceptIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A linear regression intercept series. If the
  * [type](#series.linearregressionintercept.type) option is not specified, it is

package/es-modules/Stock/Indicators/LinearRegressionSlopes/{LinearRegressionSlopes.js → LinearRegressionSlopesIndicator.js}

@@ -29,7 +29,7 @@ import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge;
 /* *
  *
- * Class
+ *  Class
  *
  * */
 /**
@@ -44,6 +44,11 @@ var extend = U.extend, merge = U.merge;
 var LinearRegressionSlopesIndicator = /** @class */ (function (_super) {
     __extends(LinearRegressionSlopesIndicator, _super);
     function LinearRegressionSlopesIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -90,6 +95,11 @@ SeriesRegistry.registerSeriesType('linearRegressionSlope', LinearRegressionSlope
  *
  * */
 export default LinearRegressionSlopesIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A linear regression intercept series. If the
  * [type](#series.linearregressionslope.type) option is not specified, it is

package/es-modules/Stock/Indicators/MACD/MACDIndicator.js

@@ -24,14 +24,15 @@ var __extends = (this && this.__extends) || (function () {
 import H from '../../../Core/Globals.js';
 var noop = H.noop;
 import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
-var _a = SeriesRegistry.seriesTypes, SMAIndicator = _a.sma, ColumnSeries = _a.column;
+var ColumnSeries = SeriesRegistry.seriesTypes.column;
+var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var extend = U.extend, correctFloat = U.correctFloat, defined = U.defined, merge = U.merge;
-/**
+/* *
  *
- * Class
+ *  Class
  *
- */
+ * */
 /**
  * The MACD series type.
  *
@@ -44,12 +45,17 @@ var extend = U.extend, correctFloat = U.correctFloat, defined = U.defined, merge
 var MACDIndicator = /** @class */ (function (_super) {
     __extends(MACDIndicator, _super);
     function MACDIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
-        /**
+        /* *
          *
-         * Properties
+         *  Properties
          *
-         */
+         * */
         _this.data = void 0;
         _this.options = void 0;
         _this.points = void 0;
@@ -60,11 +66,11 @@ var MACDIndicator = /** @class */ (function (_super) {
         _this.signalZones = void 0;
         return _this;
     }
-    /**
+    /* *
      *
-     * Functions
+     *  Functions
      *
-     */
+     * */
     MACDIndicator.prototype.init = function () {
         SeriesRegistry.seriesTypes.sma.prototype.init.apply(this, arguments);
         var originalColor = this.color, originalColorIndex = this.userOptions._colorIndex;
@@ -400,6 +406,11 @@ SeriesRegistry.registerSeriesType('macd', MACDIndicator);
  *
  * */
 export default MACDIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `MACD` series. If the [type](#series.macd.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/MFI/MFIIndicator.js

@@ -29,7 +29,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge, error = U.error, isArray = U.isArray;
-/* eslint-disable require-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 // Utils:
 function sumArray(array) {
     return array.reduce(function (prev, cur) {
@@ -45,7 +49,6 @@ function calculateTypicalPrice(point) {
 function calculateRawMoneyFlow(typicalPrice, volume) {
     return typicalPrice * volume;
 }
-/* eslint-enable require-jsdoc */
 /* *
  *
  *  Class
@@ -63,22 +66,27 @@ function calculateRawMoneyFlow(typicalPrice, volume) {
 var MFIIndicator = /** @class */ (function (_super) {
     __extends(MFIIndicator, _super);
     function MFIIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
-        *
-        *  Properties
-        *
-        * */
+         *
+         *  Properties
+         *
+         * */
         _this.data = void 0;
         _this.options = void 0;
         _this.points = void 0;
         return _this;
     }
     /* *
-    *
-    *  Functions
-    *
-    * */
+     *
+     *  Functions
+     *
+     * */
     MFIIndicator.prototype.getValues = function (series, params) {
         var period = params.period, xVal = series.xData, yVal = series.yData, yValLen = yVal ? yVal.length : 0, decimals = params.decimals, 
         // MFI starts calculations from the second point
@@ -185,6 +193,11 @@ SeriesRegistry.registerSeriesType('mfi', MFIIndicator);
  *
  * */
 export default MFIIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `MFI` series. If the [type](#series.mfi.type) option is not specified, it
  * is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/Momentum/MomentumIndicator.js

@@ -25,12 +25,20 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var extend = U.extend, isArray = U.isArray, merge = U.merge;
-/* eslint-disable require-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 function populateAverage(xVal, yVal, i, period, index) {
     var mmY = yVal[i - 1][index] - yVal[i - period - 1][index], mmX = xVal[i - 1];
     return [mmX, mmY];
 }
-/* eslint-enable require-jsdoc */
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The Momentum series type.
  *
@@ -43,12 +51,27 @@ function populateAverage(xVal, yVal, i, period, index) {
 var MomentumIndicator = /** @class */ (function (_super) {
     __extends(MomentumIndicator, _super);
     function MomentumIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
+        /* *
+         *
+         *  Properties
+         *
+         * */
         _this.data = void 0;
         _this.options = void 0;
         _this.points = void 0;
         return _this;
     }
+    /* *
+     *
+     *  Functions
+     *
+     * */
     MomentumIndicator.prototype.getValues = function (series, params) {
         var period = params.period, index = params.index, xVal = series.xData, yVal = series.yData, yValLen = yVal ? yVal.length : 0, yValue = yVal[0], MM = [], xData = [], yData = [], i, MMPoint;
         if (xVal.length <= period) {
@@ -108,6 +131,11 @@ SeriesRegistry.registerSeriesType('momentum', MomentumIndicator);
  *
  * */
 export default MomentumIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `Momentum` series. If the [type](#series.momentum.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/NATR/NATRIndicator.js

@@ -24,7 +24,12 @@ var __extends = (this && this.__extends) || (function () {
 import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var ATRIndicator = SeriesRegistry.seriesTypes.atr;
 import U from '../../../Core/Utilities.js';
-var merge = U.merge, extend = U.extend;
+var merge = U.merge;
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The NATR series type.
  *
@@ -37,6 +42,11 @@ var merge = U.merge, extend = U.extend;
 var NATRIndicator = /** @class */ (function (_super) {
     __extends(NATRIndicator, _super);
     function NATRIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /**
          * @lends Highcharts.Series#
@@ -97,6 +107,11 @@ SeriesRegistry.registerSeriesType('natr', NATRIndicator);
  *
  * */
 export default NATRIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `NATR` series. If the [type](#series.natr.type) option is not specified, it
  * is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/OBV/OBVIndicator.js

@@ -42,6 +42,11 @@ var isNumber = U.isNumber, error = U.error, extend = U.extend, merge = U.merge;
 var OBVIndicator = /** @class */ (function (_super) {
     __extends(OBVIndicator, _super);
     function OBVIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -157,6 +162,11 @@ SeriesRegistry.registerSeriesType('obv', OBVIndicator);
  *
  * */
 export default OBVIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `OBV` series. If the [type](#series.obv.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).