highcharts 10.2.0 → 10.2.1

package/es-modules/Series/XRange/XRangeSeriesDefaults.js

@@ -0,0 +1,211 @@
+/* *
+ *
+ *  X-range series module
+ *
+ *  (c) 2010-2021 Torstein Honsi, Lars A. V. Cabrera
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import U from '../../Core/Utilities.js';
+var correctFloat = U.correctFloat, isNumber = U.isNumber, isObject = U.isObject;
+/* *
+ *
+ *  Constants
+ *
+ * */
+/**
+ * The X-range series displays ranges on the X axis, typically time
+ * intervals with a start and end date.
+ *
+ * @sample {highcharts} highcharts/demo/x-range/
+ *         X-range
+ * @sample {highcharts} highcharts/css/x-range/
+ *         Styled mode X-range
+ * @sample {highcharts} highcharts/chart/inverted-xrange/
+ *         Inverted X-range
+ *
+ * @extends      plotOptions.column
+ * @since        6.0.0
+ * @product      highcharts highstock gantt
+ * @excluding    boostThreshold, crisp, cropThreshold, depth, edgeColor,
+ *               edgeWidth, findNearestPointBy, getExtremesFromAll,
+ *               negativeColor, pointInterval, pointIntervalUnit,
+ *               pointPlacement, pointRange, pointStart, softThreshold,
+ *               stacking, threshold, data, dataSorting, boostBlending
+ * @requires     modules/xrange
+ * @optionparent plotOptions.xrange
+ */
+var XRangeSeriesDefaults = {
+    /**
+     * A partial fill for each point, typically used to visualize how much
+     * of a task is performed. The partial fill object can be set either on
+     * series or point level.
+     *
+     * @sample {highcharts} highcharts/demo/x-range
+     *         X-range with partial fill
+     *
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.xrange.partialFill
+     */
+    /**
+     * The fill color to be used for partial fills. Defaults to a darker
+     * shade of the point color.
+     *
+     * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.xrange.partialFill.fill
+     */
+    /**
+     * A partial fill for each point, typically used to visualize how much
+     * of a task is performed. See [completed](series.gantt.data.completed).
+     *
+     * @sample gantt/demo/progress-indicator
+     *         Gantt with progress indicator
+     *
+     * @product   gantt
+     * @apioption plotOptions.gantt.partialFill
+     */
+    /**
+     * In an X-range series, this option makes all points of the same Y-axis
+     * category the same color.
+     */
+    colorByPoint: true,
+    dataLabels: {
+        formatter: function () {
+            var point = this.point, amount = point.partialFill;
+            if (isObject(amount)) {
+                amount = amount.amount;
+            }
+            if (isNumber(amount) && amount > 0) {
+                return correctFloat(amount * 100) + '%';
+            }
+        },
+        inside: true,
+        verticalAlign: 'middle'
+    },
+    tooltip: {
+        headerFormat: '<span style="font-size: 10px">{point.x} - {point.x2}</span><br/>',
+        pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.yCategory}</b><br/>'
+    },
+    borderRadius: 3,
+    pointRange: 0
+};
+/* *
+ *
+ *  Export Default
+ *
+ * */
+export default XRangeSeriesDefaults;
+/* *
+ *
+ * API Options
+ *
+ * */
+/**
+ * An `xrange` series. If the [type](#series.xrange.type) option is not
+ * specified, it is inherited from [chart.type](#chart.type).
+ *
+ * @extends   series,plotOptions.xrange
+ * @excluding boostThreshold, crisp, cropThreshold, depth, edgeColor, edgeWidth,
+ *            findNearestPointBy, getExtremesFromAll, negativeColor,
+ *            pointInterval, pointIntervalUnit, pointPlacement, pointRange,
+ *            pointStart, softThreshold, stacking, threshold, dataSorting,
+ *            boostBlending
+ * @product   highcharts highstock gantt
+ * @requires  modules/xrange
+ * @apioption series.xrange
+ */
+/**
+ * An array of data points for the series. For the `xrange` series type,
+ * points can be given in the following ways:
+ *
+ * 1. An array of objects with named values. The objects are point configuration
+ *    objects as seen below.
+ *    ```js
+ *    data: [{
+ *        x: Date.UTC(2017, 0, 1),
+ *        x2: Date.UTC(2017, 0, 3),
+ *        name: "Test",
+ *        y: 0,
+ *        color: "#00FF00"
+ *    }, {
+ *        x: Date.UTC(2017, 0, 4),
+ *        x2: Date.UTC(2017, 0, 5),
+ *        name: "Deploy",
+ *        y: 1,
+ *        color: "#FF0000"
+ *    }]
+ *    ```
+ *
+ * @sample {highcharts} highcharts/series/data-array-of-objects/
+ *         Config objects
+ *
+ * @declare   Highcharts.XrangePointOptionsObject
+ * @type      {Array<*>}
+ * @extends   series.line.data
+ * @product   highcharts highstock gantt
+ * @apioption series.xrange.data
+ */
+/**
+ * The starting X value of the range point.
+ *
+ * @sample {highcharts} highcharts/demo/x-range
+ *         X-range
+ *
+ * @type      {number}
+ * @product   highcharts highstock gantt
+ * @apioption series.xrange.data.x
+ */
+/**
+ * The ending X value of the range point.
+ *
+ * @sample {highcharts} highcharts/demo/x-range
+ *         X-range
+ *
+ * @type      {number}
+ * @product   highcharts highstock gantt
+ * @apioption series.xrange.data.x2
+ */
+/**
+ * The Y value of the range point.
+ *
+ * @sample {highcharts} highcharts/demo/x-range
+ *         X-range
+ *
+ * @type      {number}
+ * @product   highcharts highstock gantt
+ * @apioption series.xrange.data.y
+ */
+/**
+ * A partial fill for each point, typically used to visualize how much of
+ * a task is performed. The partial fill object can be set either on series
+ * or point level.
+ *
+ * @sample {highcharts} highcharts/demo/x-range
+ *         X-range with partial fill
+ *
+ * @declare   Highcharts.XrangePointPartialFillOptionsObject
+ * @product   highcharts highstock gantt
+ * @apioption series.xrange.data.partialFill
+ */
+/**
+ * The amount of the X-range point to be filled. Values can be 0-1 and are
+ * converted to percentages in the default data label formatter.
+ *
+ * @type      {number}
+ * @product   highcharts highstock gantt
+ * @apioption series.xrange.data.partialFill.amount
+ */
+/**
+ * The fill color to be used for partial fills. Defaults to a darker shade
+ * of the point color.
+ *
+ * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+ * @product   highcharts highstock gantt
+ * @apioption series.xrange.data.partialFill.fill
+ */
+(''); // adds doclets above to transpiled file

package/es-modules/Stock/Indicators/ABands/ABandsIndicator.js

@@ -26,7 +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;
-/* eslint-disable valid-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 /**
  * @private
  */
@@ -46,7 +50,11 @@ function getPointUB(high, base) {
 function getPointLB(low, base) {
     return low * (correctFloat(1 - 2 * base));
 }
-/* eslint-enable valid-jsdoc */
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The ABands series type
  *

package/es-modules/Stock/Indicators/AD/ADIndicator.js

@@ -24,6 +24,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var error = U.error, extend = U.extend, merge = U.merge;
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The AD series type.
  *

package/es-modules/Stock/Indicators/AO/AOIndicator.js

@@ -24,7 +24,8 @@ 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 SMAIndicator = SeriesRegistry.seriesTypes.sma;
+var columnProto = SeriesRegistry.seriesTypes.column.prototype;
 import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge, correctFloat = U.correctFloat, isArray = U.isArray;
 /* *
@@ -44,22 +45,27 @@ var extend = U.extend, merge = U.merge, correctFloat = U.correctFloat, isArray =
 var AOIndicator = /** @class */ (function (_super) {
     __extends(AOIndicator, _super);
     function AOIndicator() {
+        /* *
+         *
+         *  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
      *
-     */
+     * */
     AOIndicator.prototype.drawGraph = function () {
         var indicator = this, options = indicator.options, points = indicator.points, userColor = indicator.userOptions.color, positiveColor = options.greaterBarColor, negativeColor = options.lowerBarColor, firstPoint = points[0], i;
         if (!userColor && firstPoint) {
@@ -185,10 +191,10 @@ extend(AOIndicator.prototype, {
     nameComponents: false,
     // Columns support:
     markerAttribs: noop,
-    getColumnMetrics: ColumnSeries.prototype.getColumnMetrics,
-    crispCol: ColumnSeries.prototype.crispCol,
-    translate: ColumnSeries.prototype.translate,
-    drawPoints: ColumnSeries.prototype.drawPoints
+    getColumnMetrics: columnProto.getColumnMetrics,
+    crispCol: columnProto.crispCol,
+    translate: columnProto.translate,
+    drawPoints: columnProto.drawPoints
 });
 SeriesRegistry.registerSeriesType('ao', AOIndicator);
 /* *
@@ -197,6 +203,11 @@ SeriesRegistry.registerSeriesType('ao', AOIndicator);
  *
  * */
 export default AOIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * An `AO` series. If the [type](#series.ao.type)
  * option is not specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/APO/APOIndicator.js

@@ -21,8 +21,8 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-var EMAIndicator = SeriesRegistry.seriesTypes.ema;
 import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
+var EMAIndicator = SeriesRegistry.seriesTypes.ema;
 import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge, error = U.error;
 /* *
@@ -152,6 +152,11 @@ SeriesRegistry.registerSeriesType('apo', APOIndicator);
  *
  * */
 export default APOIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * An `Absolute Price Oscillator` series. If the [type](#series.apo.type) option
  * is not specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/ATR/ATRIndicator.js

@@ -25,7 +25,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var isArray = U.isArray, merge = U.merge;
-/* eslint-disable valid-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 // Utils:
 /**
  * @private
@@ -49,10 +53,9 @@ function populateAverage(points, xVal, yVal, i, period, prevATR) {
     y = (((prevATR * (period - 1)) + TR) / period);
     return [x, y];
 }
-/* eslint-enable valid-jsdoc */
 /* *
  *
- * Class
+ *  Class
  *
  * */
 /**
@@ -67,6 +70,11 @@ function populateAverage(points, xVal, yVal, i, period, prevATR) {
 var ATRIndicator = /** @class */ (function (_super) {
     __extends(ATRIndicator, _super);
     function ATRIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -149,6 +157,11 @@ SeriesRegistry.registerSeriesType('atr', ATRIndicator);
  *
  * */
 export default ATRIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `ATR` series. If the [type](#series.atr.type) option is not specified, it
  * is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/Aroon/AroonIndicator.js

@@ -26,7 +26,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, pick = U.pick;
-/* eslint-disable valid-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 // Utils
 // Index of element with extreme value from array (min or max)
 /**
@@ -43,7 +47,6 @@ function getExtremeIndexInArray(arr, extreme) {
     }
     return valueIndex;
 }
-/* eslint-enable valid-jsdoc */
 /* *
  *
  *  Class
@@ -61,6 +64,11 @@ function getExtremeIndexInArray(arr, extreme) {
 var AroonIndicator = /** @class */ (function (_super) {
     __extends(AroonIndicator, _super);
     function AroonIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -182,6 +190,11 @@ SeriesRegistry.registerSeriesType('aroon', AroonIndicator);
  *
  * */
 export default AroonIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A Aroon indicator. If the [type](#series.aroon.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/AroonOscillator/AroonOscillatorIndicator.js

@@ -26,7 +26,6 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var AroonIndicator = SeriesRegistry.seriesTypes.aroon;
 import U from '../../../Core/Utilities.js';
 var extend = U.extend, merge = U.merge;
-var AROON = SeriesRegistry.seriesTypes.aroon;
 /* *
  *
  *  Class
@@ -68,7 +67,7 @@ var AroonOscillatorIndicator = /** @class */ (function (_super) {
     AroonOscillatorIndicator.prototype.getValues = function (series, params) {
         // 0- date, 1- Aroon Oscillator
         var ARO = [], xData = [], yData = [], aroon, aroonUp, aroonDown, oscillator, i;
-        aroon = AROON.prototype.getValues.call(this, series, params);
+        aroon = _super.prototype.getValues.call(this, series, params);
         for (i = 0; i < aroon.yData.length; i++) {
             aroonUp = aroon.yData[i][0];
             aroonDown = aroon.yData[i][1];
@@ -124,6 +123,11 @@ SeriesRegistry.registerSeriesType('aroonoscillator', AroonOscillatorIndicator);
  *
  * */
 export default AroonOscillatorIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * An `Aroon Oscillator` series. If the [type](#series.aroonoscillator.type)
  * option is not specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/BB/BBIndicator.js

@@ -31,7 +31,6 @@ var extend = U.extend, isArray = U.isArray, merge = U.merge;
  *  Functions
  *
  * */
-/* eslint-disable valid-jsdoc */
 // Utils:
 /**
  * @private
@@ -228,6 +227,11 @@ SeriesRegistry.registerSeriesType('bb', BBIndicator);
  *
  * */
 export default BBIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A bollinger bands indicator. If the [type](#series.bb.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/CCI/CCIIndicator.js

@@ -24,7 +24,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var isArray = U.isArray, merge = U.merge;
-/* eslint-disable valid-jsdoc */
+/* *
+ *
+ *  Functions
+ *
+ * */
 // Utils:
 /**
  * @private
@@ -44,10 +48,9 @@ function meanDeviation(arr, sma) {
     }
     return sum;
 }
-/* eslint-enable valid-jsdoc */
 /* *
  *
- * Class
+ *  Class
  *
  * */
 /**
@@ -62,6 +65,11 @@ function meanDeviation(arr, sma) {
 var CCIIndicator = /** @class */ (function (_super) {
     __extends(CCIIndicator, _super);
     function CCIIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -141,6 +149,11 @@ SeriesRegistry.registerSeriesType('cci', CCIIndicator);
  *
  * */
 export default CCIIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `CCI` series. If the [type](#series.cci.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/CMF/CMFIndicator.js

@@ -31,6 +31,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var merge = U.merge;
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The CMF series type.
  *
@@ -43,6 +48,11 @@ var merge = U.merge;
 var CMFIndicator = /** @class */ (function (_super) {
     __extends(CMFIndicator, _super);
     function CMFIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -58,6 +68,11 @@ var CMFIndicator = /** @class */ (function (_super) {
         _this.nameBase = 'Chaikin Money Flow';
         return _this;
     }
+    /* *
+     *
+     *  Functions
+     *
+     * */
     /**
      * Checks if the series and volumeSeries are accessible, number of
      * points.x is longer than period, is series has OHLC data
@@ -230,6 +245,11 @@ SeriesRegistry.registerSeriesType('cmf', CMFIndicator);
  *
  * */
 export default CMFIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `CMF` series. If the [type](#series.cmf.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/CMO/CMOIndicator.js

@@ -25,7 +25,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var SMAIndicator = SeriesRegistry.seriesTypes.sma;
 import U from '../../../Core/Utilities.js';
 var isNumber = U.isNumber, merge = U.merge;
-/* eslint-enable require-jsdoc */
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The CMO series type.
  *
@@ -38,6 +42,11 @@ var isNumber = U.isNumber, merge = U.merge;
 var CMOIndicator = /** @class */ (function (_super) {
     __extends(CMOIndicator, _super);
     function CMOIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
         /* *
          *
@@ -153,6 +162,11 @@ SeriesRegistry.registerSeriesType('cmo', CMOIndicator);
  *
  * */
 export default CMOIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `CMO` series. If the [type](#series.cmo.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js

@@ -21,9 +21,9 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+import AD from '../AD/ADIndicator.js'; // For historic reasons, AD is built into Chaikin
 import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
-import '../AD/ADIndicator.js'; // For historic reasons, AD i built into Chaikin
-var _a = SeriesRegistry.seriesTypes, AD = _a.ad, EMAIndicator = _a.ema;
+var EMAIndicator = SeriesRegistry.seriesTypes.ema;
 import U from '../../../Core/Utilities.js';
 var correctFloat = U.correctFloat, extend = U.extend, merge = U.merge, error = U.error;
 /* *
@@ -172,6 +172,11 @@ SeriesRegistry.registerSeriesType('chaikin', ChaikinIndicator);
  *
  * */
 export default ChaikinIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `Chaikin Oscillator` series. If the [type](#series.chaikin.type)
  * option is not specified, it is inherited from [chart.type](#chart.type).

package/es-modules/Stock/Indicators/DEMA/DEMAIndicator.js

@@ -25,6 +25,11 @@ import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 var EMAIndicator = SeriesRegistry.seriesTypes.ema;
 import U from '../../../Core/Utilities.js';
 var correctFloat = U.correctFloat, isArray = U.isArray, merge = U.merge;
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The DEMA series Type
  *
@@ -37,13 +42,28 @@ var correctFloat = U.correctFloat, isArray = U.isArray, merge = U.merge;
 var DEMAIndicator = /** @class */ (function (_super) {
     __extends(DEMAIndicator, _super);
     function DEMAIndicator() {
+        /* *
+         *
+         *  Static Properties
+         *
+         * */
         var _this = _super !== null && _super.apply(this, arguments) || this;
+        /* *
+         *
+         *  Properties
+         *
+         * */
         _this.EMApercent = void 0;
         _this.data = void 0;
         _this.options = void 0;
         _this.points = void 0;
         return _this;
     }
+    /* *
+     *
+     *  Functions
+     *
+     * */
     DEMAIndicator.prototype.getEMA = function (yVal, prevEMA, SMA, index, i, xVal) {
         return EMAIndicator.prototype.calculateEma(xVal || [], yVal, typeof i === 'undefined' ? 1 : i, this.EMApercent, prevEMA, typeof index === 'undefined' ? -1 : index, SMA);
     };
@@ -134,6 +154,11 @@ SeriesRegistry.registerSeriesType('dema', DEMAIndicator);
  *
  * */
 export default DEMAIndicator;
+/* *
+ *
+ *  API Options
+ *
+ * */
 /**
  * A `DEMA` series. If the [type](#series.dema.type) option is not
  * specified, it is inherited from [chart.type](#chart.type).