highcharts 10.2.1 → 10.3.1

package/es-modules/Series/OHLC/OHLCPoint.js

@@ -44,14 +44,12 @@ var OHLCPoint = /** @class */ (function (_super) {
         _this.plotOpen = void 0;
         _this.series = void 0;
         return _this;
-        /* eslint-enable valid-jsdoc */
     }
     /* *
      *
      *  Functions
      *
      * */
-    /* eslint-disable valid-jsdoc */
     /**
      * Extend the parent method by adding up or down to the class name.
      * @private

package/es-modules/Series/OHLC/OHLCSeries.js

@@ -24,10 +24,55 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import OHLCPoint from './OHLCPoint.js';
+import OHLCSeriesDefaults from './OHLCSeriesDefaults.js';
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
-var Series = SeriesRegistry.series, HLCSeries = SeriesRegistry.seriesTypes.hlc;
+var HLCSeries = SeriesRegistry.seriesTypes.hlc;
 import U from '../../Core/Utilities.js';
 var addEvent = U.addEvent, extend = U.extend, merge = U.merge;
+/* *
+ *
+ *  Constants
+ *
+ * */
+var composedMembers = [];
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * @private
+ */
+function onSeriesAfterSetOptions(e) {
+    var options = e.options, dataGrouping = options.dataGrouping;
+    if (dataGrouping &&
+        options.useOhlcData &&
+        options.id !== 'highcharts-navigator-series') {
+        dataGrouping.approximation = 'ohlc';
+    }
+}
+/**
+ * Add useOhlcData option
+ * @private
+ */
+function onSeriesInit(eventOptions) {
+    // eslint-disable-next-line no-invalid-this
+    var series = this, options = eventOptions.options;
+    if (options.useOhlcData &&
+        options.id !== 'highcharts-navigator-series') {
+        extend(series, {
+            pointValKey: OHLCSeries.prototype.pointValKey,
+            // keys: ohlcProto.keys, // @todo potentially nonsense
+            pointArrayMap: OHLCSeries.prototype.pointArrayMap,
+            toYData: OHLCSeries.prototype.toYData
+        });
+    }
+}
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The ohlc series type.
  *
@@ -56,6 +101,22 @@ var OHLCSeries = /** @class */ (function (_super) {
         _this.points = void 0;
         return _this;
     }
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
+    OHLCSeries.compose = function (SeriesClass) {
+        var _args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            _args[_i - 1] = arguments[_i];
+        }
+        if (composedMembers.indexOf(SeriesClass) === -1) {
+            composedMembers.push(SeriesClass);
+            addEvent(SeriesClass, 'afterSetOptions', onSeriesAfterSetOptions);
+            addEvent(SeriesClass, 'init', onSeriesInit);
+        }
+    };
     /* *
      *
      *  Functions
@@ -72,7 +133,6 @@ var OHLCSeries = /** @class */ (function (_super) {
         }
         return path;
     };
-    /* eslint-disable valid-jsdoc */
     /**
      * Postprocess mapping between options and SVG attributes
      * @private
@@ -91,68 +151,13 @@ var OHLCSeries = /** @class */ (function (_super) {
         // return a plain array for speedy calculation
         return [point.open, point.high, point.low, point.close];
     };
-    /**
-     * An OHLC chart is a style of financial chart used to describe price
-     * movements over time. It displays open, high, low and close values per
-     * data point.
-     *
-     * @sample stock/demo/ohlc/
-     *         OHLC chart
-     *
-     * @extends      plotOptions.hlc
-     * @product      highstock
-     * @optionparent plotOptions.ohlc
-     */
-    /**
-     * The parameter allows setting line series type and use OHLC indicators.
-     * Data in OHLC format is required.
-     *
-     * @sample {highstock} stock/indicators/use-ohlc-data
-     *         Use OHLC data format to plot line chart
-     *
-     * @type      {boolean}
-     * @product   highstock
-     * @apioption plotOptions.line.useOhlcData
-     */
-    OHLCSeries.defaultOptions = merge(HLCSeries.defaultOptions, {
-        /**
-         * @type      {Highcharts.DataGroupingApproximationValue|Function}
-         * @default   ohlc
-         * @product   highstock
-         * @apioption plotOptions.ohlc.dataGrouping.approximation
-         */
-        tooltip: {
-            pointFormat: '<span style="color:{point.color}">\u25CF</span> ' +
-                '<b> {series.name}</b><br/>' +
-                'Open: {point.open}<br/>' +
-                'High: {point.high}<br/>' +
-                'Low: {point.low}<br/>' +
-                'Close: {point.close}<br/>'
-        }
-        /**
-         * Determines which one of  `open`, `high`, `low`, `close` values should
-         * be represented as `point.y`, which is later used to set dataLabel
-         * position and [compare](#plotOptions.series.compare).
-         *
-         * @default    close
-         * @validvalue ["open", "high", "low", "close"]
-         * @product    highstock
-         * @apioption  plotOptions.ohlc.pointValKey
-         */
-        /**
-         * Line color for up points.
-         *
-         * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
-         * @product   highstock
-         * @apioption plotOptions.ohlc.upColor
-         */
-    });
+    OHLCSeries.defaultOptions = merge(HLCSeries.defaultOptions, OHLCSeriesDefaults);
     return OHLCSeries;
 }(HLCSeries));
 extend(OHLCSeries.prototype, {
+    pointClass: OHLCPoint,
     pointArrayMap: ['open', 'high', 'low', 'close']
 });
-OHLCSeries.prototype.pointClass = OHLCPoint;
 SeriesRegistry.registerSeriesType('ohlc', OHLCSeries);
 /* *
  *
@@ -160,104 +165,3 @@ SeriesRegistry.registerSeriesType('ohlc', OHLCSeries);
  *
  * */
 export default OHLCSeries;
-// Add useOhlcData option
-addEvent(Series, 'init', function (eventOptions) {
-    // eslint-disable-next-line no-invalid-this
-    var series = this, options = eventOptions.options;
-    if (options.useOhlcData &&
-        options.id !== 'highcharts-navigator-series') {
-        extend(series, {
-            pointValKey: OHLCSeries.prototype.pointValKey,
-            // keys: ohlcProto.keys, // @todo potentially nonsense
-            pointArrayMap: OHLCSeries.prototype.pointArrayMap,
-            toYData: OHLCSeries.prototype.toYData
-        });
-    }
-});
-addEvent(Series, 'afterSetOptions', function (e) {
-    var options = e.options, dataGrouping = options.dataGrouping;
-    if (dataGrouping &&
-        options.useOhlcData &&
-        options.id !== 'highcharts-navigator-series') {
-        dataGrouping.approximation = 'ohlc';
-    }
-});
-/* *
- *
- *  API Options
- *
- * */
-/**
- * A `ohlc` series. If the [type](#series.ohlc.type) option is not
- * specified, it is inherited from [chart.type](#chart.type).
- *
- * @extends   series,plotOptions.ohlc
- * @excluding dataParser, dataURL
- * @product   highstock
- * @apioption series.ohlc
- */
-/**
- * An array of data points for the series. For the `ohlc` series type,
- * points can be given in the following ways:
- *
- * 1. An array of arrays with 5 or 4 values. In this case, the values correspond
- *    to `x,open,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 4\.
- *    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, 6, 5, 6, 7],
- *        [1, 9, 4, 8, 2],
- *        [2, 6, 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.ohlc.turboThreshold), this option is not
- *    available.
- *    ```js
- *    data: [{
- *        x: 1,
- *        open: 3,
- *        high: 4,
- *        low: 5,
- *        close: 2,
- *        name: "Point2",
- *        color: "#00FF00"
- *    }, {
- *        x: 1,
- *        open: 4,
- *        high: 3,
- *        low: 6,
- *        close: 7,
- *        name: "Point1",
- *        color: "#FF00FF"
- *    }]
- *    ```
- *
- * @type      {Array<Array<(number|string),number,number,number>|Array<(number|string),number,number,number,number>|*>}
- * @extends   series.arearange.data
- * @excluding y, marker
- * @product   highstock
- * @apioption series.ohlc.data
- */
-/**
- * The closing value of each data point.
- *
- * @type      {number}
- * @product   highstock
- * @apioption series.ohlc.data.close
- */
-/**
- * The opening value of each data point.
- *
- * @type      {number}
- * @product   highstock
- * @apioption series.ohlc.data.open
- */
-''; // adds doclets above to transpilat

package/es-modules/Series/OHLC/OHLCSeriesDefaults.js

@@ -0,0 +1,151 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * An OHLC chart is a style of financial chart used to describe price
+ * movements over time. It displays open, high, low and close values per
+ * data point.
+ *
+ * @sample stock/demo/ohlc
+ *         OHLC chart
+ *
+ * @extends      plotOptions.hlc
+ * @product      highstock
+ * @optionparent plotOptions.ohlc
+ */
+var OHLCSeriesDefaults = {
+    /**
+     * @type      {Highcharts.DataGroupingApproximationValue|Function}
+     * @default   ohlc
+     * @product   highstock
+     * @apioption plotOptions.ohlc.dataGrouping.approximation
+     */
+    /**
+     * Determines which one of  `open`, `high`, `low`, `close` values should
+     * be represented as `point.y`, which is later used to set dataLabel
+     * position and [compare](#plotOptions.series.compare).
+     *
+     * @default    close
+     * @validvalue ["open", "high", "low", "close"]
+     * @product    highstock
+     * @apioption  plotOptions.ohlc.pointValKey
+     */
+    /**
+     * Line color for up points.
+     *
+     * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+     * @product   highstock
+     * @apioption plotOptions.ohlc.upColor
+     */
+    tooltip: {
+        pointFormat: '<span style="color:{point.color}">\u25CF</span> ' +
+            '<b> {series.name}</b><br/>' +
+            'Open: {point.open}<br/>' +
+            'High: {point.high}<br/>' +
+            'Low: {point.low}<br/>' +
+            'Close: {point.close}<br/>'
+    }
+};
+/**
+ * The parameter allows setting line series type and use OHLC indicators.
+ * Data in OHLC format is required.
+ *
+ * @sample {highstock} stock/indicators/use-ohlc-data
+ *         Use OHLC data format to plot line chart
+ *
+ * @type      {boolean}
+ * @product   highstock
+ * @apioption plotOptions.line.useOhlcData
+ */
+/**
+ * A `ohlc` series. If the [type](#series.ohlc.type) option is not
+ * specified, it is inherited from [chart.type](#chart.type).
+ *
+ * @extends   series,plotOptions.ohlc
+ * @excluding dataParser, dataURL
+ * @product   highstock
+ * @apioption series.ohlc
+ */
+/**
+ * An array of data points for the series. For the `ohlc` series type,
+ * points can be given in the following ways:
+ *
+ * 1. An array of arrays with 5 or 4 values. In this case, the values correspond
+ *    to `x,open,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 4\.
+ *    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, 6, 5, 6, 7],
+ *        [1, 9, 4, 8, 2],
+ *        [2, 6, 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.ohlc.turboThreshold), this option is not
+ *    available.
+ *    ```js
+ *    data: [{
+ *        x: 1,
+ *        open: 3,
+ *        high: 4,
+ *        low: 5,
+ *        close: 2,
+ *        name: "Point2",
+ *        color: "#00FF00"
+ *    }, {
+ *        x: 1,
+ *        open: 4,
+ *        high: 3,
+ *        low: 6,
+ *        close: 7,
+ *        name: "Point1",
+ *        color: "#FF00FF"
+ *    }]
+ *    ```
+ *
+ * @type      {Array<Array<(number|string),number,number,number>|Array<(number|string),number,number,number,number>|*>}
+ * @extends   series.arearange.data
+ * @excluding y, marker
+ * @product   highstock
+ * @apioption series.ohlc.data
+ */
+/**
+ * The closing value of each data point.
+ *
+ * @type      {number}
+ * @product   highstock
+ * @apioption series.ohlc.data.close
+ */
+/**
+ * The opening value of each data point.
+ *
+ * @type      {number}
+ * @product   highstock
+ * @apioption series.ohlc.data.open
+ */
+''; // adds doclets above to transpilat
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default OHLCSeriesDefaults;

package/es-modules/Series/Organization/OrganizationPoint.js

@@ -71,14 +71,12 @@ var OrganizationPoint = /** @class */ (function (_super) {
         _this.series = void 0;
         _this.toNode = void 0;
         return _this;
-        /* eslint-enable valid-jsdoc */
     }
     /* *
      *
      *  Functions
      *
      * */
-    /* eslint-disable valid-jsdoc */
     /**
      * All nodes in an org chart are equal width.
      * @private