highcharts 10.2.1 → 10.3.1

package/es-modules/Series/HLC/HLCSeries.js

@@ -24,6 +24,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import HLCPoint from './HLCPoint.js';
+import HLCSeriesDefaults from './HLCSeriesDefaults.js';
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
 var ColumnSeries = SeriesRegistry.seriesTypes.column;
 import U from '../../Core/Utilities.js';
@@ -61,14 +62,12 @@ var HLCSeries = /** @class */ (function (_super) {
         _this.points = void 0;
         _this.yData = void 0;
         return _this;
-        /* eslint-enable valid-jsdoc */
     }
     /* *
      *
      *  Functions
      *
      * */
-    /* eslint-disable valid-jsdoc */
     /**
      * Extend the path if close is not between high and low.
      *
@@ -98,9 +97,9 @@ var HLCSeries = /** @class */ (function (_super) {
         var strokeWidth = graphic.strokeWidth(), series = point.series, crispCorr = (strokeWidth % 2) / 2, 
         // #2596:
         crispX = Math.round(point.plotX) - crispCorr, halfWidth = Math.round(point.shapeArgs.width / 2);
-        var path, plotClose = point.plotClose;
+        var plotClose = point.plotClose;
         // the vertical stem
-        path = [
+        var path = [
             ['M', crispX, Math.round(point.yBottom)],
             ['L', crispX, Math.round(point.plotHigh)]
         ];
@@ -118,7 +117,7 @@ var HLCSeries = /** @class */ (function (_super) {
      */
     HLCSeries.prototype.drawSinglePoint = function (point) {
         var series = point.series, chart = series.chart;
-        var path, graphic = point.graphic, isNew = !graphic;
+        var path, graphic = point.graphic;
         if (typeof point.plotY !== 'undefined') {
             // Create and/or update the graphic
             if (!graphic) {
@@ -130,7 +129,7 @@ var HLCSeries = /** @class */ (function (_super) {
             }
             // crisp vector coordinates
             path = series.getPointPath(point, graphic);
-            graphic[isNew ? 'attr' : 'animate']({ d: path })
+            graphic[!graphic ? 'attr' : 'animate']({ d: path })
                 .addClass(point.getClassName(), true);
         }
     };
@@ -193,104 +192,11 @@ var HLCSeries = /** @class */ (function (_super) {
                 point.plotHigh + yAxis.pos - series.chart.plotTop;
         });
     };
-    /**
-     * An HLC chart is a style of financial chart used to describe price
-     * movements over time. It displays high, low and close values per
-     * data point.
-     *
-     * @sample stock/demo/hlc/
-     *         HLC chart
-     *
-     * @extends      plotOptions.column
-     * @excluding    borderColor, borderRadius, borderWidth, crisp, stacking,
-     *               stack
-     * @product      highstock
-     * @optionparent plotOptions.hlc
-     */
-    HLCSeries.defaultOptions = merge(ColumnSeries.defaultOptions, {
-        /**
-         * The approximate pixel width of each group. If for example a series
-         * with 30 points is displayed over a 600 pixel wide plot area, no
-         * grouping is performed. If however the series contains so many points
-         * that the spacing is less than the groupPixelWidth, Highcharts will
-         * try to group it into appropriate groups so that each is more or less
-         * two pixels wide. Defaults to `5`.
-         *
-         * @type      {number}
-         * @default   5
-         * @product   highstock
-         * @apioption plotOptions.hlc.dataGrouping.groupPixelWidth
-         */
-        /**
-         * @type      {Highcharts.DataGroupingApproximationValue|Function}
-         * @default   hlc
-         * @product   highstock
-         * @apioption plotOptions.hlc.dataGrouping.approximation
-         */
-        /**
-         * @default   close
-         * @apioption plotOptions.hlc.colorKey
-         */
-        /**
-         * The pixel width of the line/border. Defaults to `1`.
-         *
-         * @sample {highstock} stock/plotoptions/hlc-linewidth/
-         *         A greater line width
-         *
-         * @type    {number}
-         * @default 1
-         * @product highstock
-         *
-         * @public
-         */
-        lineWidth: 1,
-        tooltip: {
-            pointFormat: '<span style="color:{point.color}">\u25CF</span> ' +
-                '<b> {series.name}</b><br/>' +
-                'High: {point.high}<br/>' +
-                'Low: {point.low}<br/>' +
-                'Close: {point.close}<br/>'
-        },
-        threshold: null,
-        states: {
-            /**
-             * @extends plotOptions.column.states.hover
-             * @product highstock
-             */
-            hover: {
-                /**
-                 * The pixel width of the line representing the HLC point.
-                 *
-                 * @type    {number}
-                 * @default 3
-                 * @product highstock
-                 */
-                lineWidth: 3
-            }
-        },
-        /**
-         * Determines which one of  `high`, `low`, `close` values should
-         * be represented as `point.y`, which is later used to set dataLabel
-         * position and [compare](#plotOptions.series.compare).
-         *
-         * @sample {highstock} stock/plotoptions/hlc-pointvalkey/
-         *         Possible values
-         *
-         * @type       {string}
-         * @default    close
-         * @validvalue ["high", "low", "close"]
-         * @product    highstock
-         * @apioption  plotOptions.hlc.pointValKey
-         */
-        /**
-         * @default   close
-         * @apioption plotOptions.hlc.colorKey
-         */
-        stickyTracking: true
-    });
+    HLCSeries.defaultOptions = merge(ColumnSeries.defaultOptions, HLCSeriesDefaults);
     return HLCSeries;
 }(ColumnSeries));
 extend(HLCSeries.prototype, {
+    pointClass: HLCPoint,
     animate: null,
     directTouch: false,
     pointArrayMap: ['high', 'low', 'close'],
@@ -300,7 +206,6 @@ extend(HLCSeries.prototype, {
     },
     pointValKey: 'close'
 });
-HLCSeries.prototype.pointClass = HLCPoint;
 SeriesRegistry.registerSeriesType('hlc', HLCSeries);
 /* *
  *
@@ -308,73 +213,3 @@ SeriesRegistry.registerSeriesType('hlc', HLCSeries);
  *
  * */
 export default HLCSeries;
-/* *
- *
- *  API Options
- *
- * */
-/**
- * A `hlc` series. If the [type](#series.hlc.type) option is not
- * specified, it is inherited from [chart.type](#chart.type).
- *
- * @extends   series,plotOptions.hlc
- * @excluding dataParser, dataURL
- * @product   highstock
- * @apioption series.hlc
- */
-/**
- * An array of data points for the series. For the `hlc` series type,
- * points can be given in the following ways:
- *
- * 1. An array of arrays with 4 or 3 values. In this case, the values correspond
- *    to `x,high,low,close`. If the first value is a string, it is applied
- *    as the name of the point, and the `x` value is inferred. The `x` value can
- *    also be omitted, in which case the inner arrays should be of length of 3\.
- *    Then the `x` value is automatically calculated, either starting at 0 and
- *    incremented by 1, or from `pointStart` and `pointInterval` given in the
- *    series options.
- *    ```js
- *    data: [
- *        [0, 5, 6, 7],
- *        [1, 4, 8, 2],
- *        [2, 3, 4, 10]
- *    ]
- *    ```
- *
- * 2. An array of objects with named values. The following snippet shows only a
- *    few settings, see the complete options set below. If the total number of
- *    data points exceeds the series'
- *    [turboThreshold](#series.hlc.turboThreshold), this option is not
- *    available.
- *    ```js
- *    data: [{
- *        x: 1,
- *        high: 4,
- *        low: 5,
- *        close: 2,
- *        name: "Point2",
- *        color: "#00FF00"
- *    }, {
- *        x: 1,
- *        high: 3,
- *        low: 6,
- *        close: 7,
- *        name: "Point1",
- *        color: "#FF00FF"
- *    }]
- *    ```
- *
- * @type      {Array<Array<(number|string),number,number>|Array<(number|string),number,number,number>|*>}
- * @extends   series.arearange.data
- * @excluding y, marker
- * @product   highstock
- * @apioption series.hlc.data
- */
-/**
- * The closing value of each data point.
- *
- * @type      {number}
- * @product   highstock
- * @apioption series.hlc.data.close
- */
-''; // adds doclets above to transpilat

package/es-modules/Series/HLC/HLCSeriesDefaults.js

@@ -0,0 +1,184 @@
+/* *
+ *
+ *  (c) 2010-2021 Pawel Lysy
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * An HLC chart is a style of financial chart used to describe price
+ * movements over time. It displays high, low and close values per
+ * data point.
+ *
+ * @sample stock/demo/hlc/
+ *         HLC chart
+ *
+ * @extends      plotOptions.column
+ * @excluding    borderColor, borderRadius, borderWidth, crisp, stacking,
+ *               stack
+ * @product      highstock
+ * @optionparent plotOptions.hlc
+ */
+var HLCSeriesDefaults = {
+    /**
+     * The approximate pixel width of each group. If for example a series
+     * with 30 points is displayed over a 600 pixel wide plot area, no
+     * grouping is performed. If however the series contains so many points
+     * that the spacing is less than the groupPixelWidth, Highcharts will
+     * try to group it into appropriate groups so that each is more or less
+     * two pixels wide. Defaults to `5`.
+     *
+     * @type      {number}
+     * @default   5
+     * @product   highstock
+     * @apioption plotOptions.hlc.dataGrouping.groupPixelWidth
+     */
+    /**
+     * @type      {Highcharts.DataGroupingApproximationValue|Function}
+     * @default   hlc
+     * @product   highstock
+     * @apioption plotOptions.hlc.dataGrouping.approximation
+     */
+    /**
+     * @default   close
+     * @apioption plotOptions.hlc.colorKey
+     */
+    /**
+     * The pixel width of the line/border. Defaults to `1`.
+     *
+     * @sample {highstock} stock/plotoptions/hlc-linewidth/
+     *         A greater line width
+     *
+     * @type    {number}
+     * @default 1
+     * @product highstock
+     *
+     * @public
+     */
+    lineWidth: 1,
+    tooltip: {
+        pointFormat: '<span style="color:{point.color}">\u25CF</span> ' +
+            '<b> {series.name}</b><br/>' +
+            'High: {point.high}<br/>' +
+            'Low: {point.low}<br/>' +
+            'Close: {point.close}<br/>'
+    },
+    /**
+     * @type {number|null}
+     */
+    threshold: null,
+    states: {
+        /**
+         * @extends plotOptions.column.states.hover
+         * @product highstock
+         */
+        hover: {
+            /**
+             * The pixel width of the line representing the HLC point.
+             *
+             * @type    {number}
+             * @default 3
+             * @product highstock
+             */
+            lineWidth: 3
+        }
+    },
+    /**
+     * Determines which one of  `high`, `low`, `close` values should
+     * be represented as `point.y`, which is later used to set dataLabel
+     * position and [compare](#plotOptions.series.compare).
+     *
+     * @sample {highstock} stock/plotoptions/hlc-pointvalkey/
+     *         Possible values
+     *
+     * @type       {string}
+     * @default    close
+     * @validvalue ["high", "low", "close"]
+     * @product    highstock
+     * @apioption  plotOptions.hlc.pointValKey
+     */
+    /**
+     * @default   close
+     * @apioption plotOptions.hlc.colorKey
+     */
+    stickyTracking: true
+};
+/**
+ * A `hlc` series. If the [type](#series.hlc.type) option is not
+ * specified, it is inherited from [chart.type](#chart.type).
+ *
+ * @extends   series,plotOptions.hlc
+ * @excluding dataParser, dataURL
+ * @product   highstock
+ * @apioption series.hlc
+ */
+/**
+ * An array of data points for the series. For the `hlc` series type,
+ * points can be given in the following ways:
+ *
+ * 1. An array of arrays with 4 or 3 values. In this case, the values correspond
+ *    to `x,high,low,close`. If the first value is a string, it is applied
+ *    as the name of the point, and the `x` value is inferred. The `x` value can
+ *    also be omitted, in which case the inner arrays should be of length of 3\.
+ *    Then the `x` value is automatically calculated, either starting at 0 and
+ *    incremented by 1, or from `pointStart` and `pointInterval` given in the
+ *    series options.
+ *    ```js
+ *    data: [
+ *        [0, 5, 6, 7],
+ *        [1, 4, 8, 2],
+ *        [2, 3, 4, 10]
+ *    ]
+ *    ```
+ *
+ * 2. An array of objects with named values. The following snippet shows only a
+ *    few settings, see the complete options set below. If the total number of
+ *    data points exceeds the series'
+ *    [turboThreshold](#series.hlc.turboThreshold), this option is not
+ *    available.
+ *    ```js
+ *    data: [{
+ *        x: 1,
+ *        high: 4,
+ *        low: 5,
+ *        close: 2,
+ *        name: "Point2",
+ *        color: "#00FF00"
+ *    }, {
+ *        x: 1,
+ *        high: 3,
+ *        low: 6,
+ *        close: 7,
+ *        name: "Point1",
+ *        color: "#FF00FF"
+ *    }]
+ *    ```
+ *
+ * @type      {Array<Array<(number|string),number,number>|Array<(number|string),number,number,number>|*>}
+ * @extends   series.arearange.data
+ * @excluding y, marker
+ * @product   highstock
+ * @apioption series.hlc.data
+ */
+/**
+ * The closing value of each data point.
+ *
+ * @type      {number}
+ * @product   highstock
+ * @apioption series.hlc.data.close
+ */
+(''); // keeps doclets above in JS file
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default HLCSeriesDefaults;

package/es-modules/Series/Heatmap/HeatmapSeries.js

@@ -384,6 +384,9 @@ var HeatmapSeries = /** @class */ (function (_super) {
             inside: true,
             verticalAlign: 'middle',
             crop: false,
+            /**
+             * @ignore-option
+             */
             overflow: false,
             padding: 0 // #3837
         },

package/es-modules/Series/HeikinAshi/HeikinAshiPoint.js

@@ -23,13 +23,8 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-/* *
- *
- *  Imports
- *
- * */
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
-var CandlestickSeries = SeriesRegistry.seriesTypes.candlestick;
+var CandlestickPoint = SeriesRegistry.seriesTypes.candlestick.prototype.pointClass;
 /* *
  *
  *  Class
@@ -38,22 +33,10 @@ var CandlestickSeries = SeriesRegistry.seriesTypes.candlestick;
 var HeikinAshiPoint = /** @class */ (function (_super) {
     __extends(HeikinAshiPoint, _super);
     function HeikinAshiPoint() {
-        /* *
-         *
-         *  Properties
-         *
-         * */
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.series = void 0;
-        return _this;
-        /* *
-         *
-         *  Functions
-         *
-         * */
+        return _super !== null && _super.apply(this, arguments) || this;
     }
     return HeikinAshiPoint;
-}(CandlestickSeries.prototype.pointClass));
+}(CandlestickPoint));
 /* *
  *
  *  Default Export