highcharts 11.3.0 → 11.4.0

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

@@ -57,7 +57,7 @@ class CMOIndicator extends SMAIndicator {
                 sumOfLowerValues += values[j - 1] - values[j];
             }
         }
-        // You might devide by 0 if all values are equal,
+        // You might divide by 0 if all values are equal,
         // so return 0 in this case.
         y =
             sumOfHigherValues + sumOfLowerValues > 0 ?
@@ -76,7 +76,7 @@ class CMOIndicator extends SMAIndicator {
                 sumOfLowerValues += values[i - 1] - values[i];
             }
             // Check, to which sum was the first value added to,
-            // and substract this value from given sum.
+            // and subtract this value from given sum.
             if (values[i - period] > values[i - period - 1]) {
                 sumOfHigherValues -= firstAddedSum;
             }

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

@@ -102,7 +102,7 @@ class ChaikinIndicator extends EMAIndicator {
  */
 ChaikinIndicator.defaultOptions = merge(EMAIndicator.defaultOptions, {
     /**
-     * Paramters used in calculation of Chaikin Oscillator
+     * Parameters used in calculation of Chaikin Oscillator
      * series points.
      *
      * @excluding index

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

@@ -67,7 +67,7 @@ class DPOIndicator extends SMAIndicator {
             sum = accumulatePoints(sum, yVal, periodIndex, index);
             price = pick(yVal[rangeIndex][index], yVal[rangeIndex]);
             oscillator = price - sum / period;
-            // substracting the first period point
+            // subtracting the first period point
             sum = accumulatePoints(sum, yVal, j, index, true);
             DPO.push([xVal[rangeIndex], oscillator]);
             xData.push(xVal[rangeIndex]);

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

@@ -158,7 +158,7 @@ class KlingerIndicator extends SMAIndicator {
  */
 KlingerIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
     /**
-     * Paramters used in calculation of Klinger Oscillator.
+     * Parameters used in calculation of Klinger Oscillator.
      *
      * @excluding index, period
      */

package/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js

@@ -185,10 +185,10 @@ LinearRegressionIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
     params: {
         /**
          * Unit (in milliseconds) for the x axis distances used to
-         * compute the regression line paramters (slope & intercept) for
-         * every range. In Highcharts Stock the x axis values are always
-         * represented in milliseconds which may cause that distances
-         * between points are "big" integer numbers.
+         * compute the regression line parameters (slope & intercept)
+         * for every range. In Highcharts Stock the x axis values are
+         * always represented in milliseconds which may cause that
+         * distances between points are "big" integer numbers.
          *
          * Highcharts Stock's linear regression algorithm (least squares
          * method) will utilize these "big" integers for finding the
@@ -196,10 +196,10 @@ LinearRegressionIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
          * period. In consequence, this value may be a very "small"
          * decimal number that's hard to interpret by a human.
          *
-         * For instance: `xAxisUnit` equealed to `86400000` ms (1 day)
+         * For instance: `xAxisUnit` equaled to `86400000` ms (1 day)
          * forces the algorithm to treat `86400000` as `1` while
-         * computing the slope and the intercept. This may enchance the
-         * legiblitity of the indicator's values.
+         * computing the slope and the intercept. This may enhance the
+         * legibility of the indicator's values.
          *
          * Default value is the closest distance between two data
          * points.

package/es-modules/Stock/Indicators/MultipleLinesComposition.js

@@ -25,10 +25,10 @@ var MultipleLinesComposition;
      *
      * */
     /* *
-    *
-    *  Constants
-    *
-    * */
+     *
+     *  Constants
+     *
+     * */
     /**
      * Additional lines DOCS names. Elements of linesApiNames array should
      * be consistent with DOCS line names defined in your implementation.
@@ -51,7 +51,7 @@ var MultipleLinesComposition;
      */
     const pointArrayMap = ['top', 'bottom'];
     /**
-     * Names of the lines, bewteen which the area should be plotted.
+     * Names of the lines, between which the area should be plotted.
      * If the drawing of the area should
      * be disabled for some indicators, leave this option as an empty array.
      * Names should be the same as the names in the pointArrayMap.
@@ -68,10 +68,10 @@ var MultipleLinesComposition;
      */
     const pointValKey = 'top';
     /* *
-    *
-    *  Functions
-    *
-    * */
+     *
+     *  Functions
+     *
+     * */
     /**
      * Composition useful for all indicators that have more than one line.
      * Compose it with your implementation where you will provide the

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

@@ -115,7 +115,7 @@ OBVIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
         period: void 0,
         /**
          * The id of another series to use its data as volume data for the
-         * indiator calculation.
+         * indicator calculation.
          */
         volumeSeriesID: 'volume'
     },

package/es-modules/Stock/Indicators/PPO/PPOIndicator.js

@@ -97,7 +97,7 @@ class PPOIndicator extends EMAIndicator {
  */
 PPOIndicator.defaultOptions = merge(EMAIndicator.defaultOptions, {
     /**
-     * Paramters used in calculation of Percentage Price Oscillator series
+     * Parameters used in calculation of Percentage Price Oscillator series
      * points.
      *
      * @excluding period

package/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js

@@ -88,7 +88,7 @@ class PivotPointsIndicator extends SMAIndicator {
         let currentLabel, pointsLength, point, i;
         if (indicator.options.dataLabels.enabled) {
             pointsLength = indicator.points.length;
-            // For every Ressitance/Support group we need to render labels.
+            // For every Resistance/Support group we need to render labels.
             // Add one more item, which will just store dataLabels from
             // previous iteration
             pointMapping.concat([false]).forEach((position, k) => {
@@ -239,7 +239,7 @@ PivotPointsIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
         index: void 0,
         period: 28,
         /**
-         * Algorithm used to calculate ressistance and support lines based
+         * Algorithm used to calculate resistance and support lines based
          * on pivot points. Implemented algorithms: `'standard'`,
          * `'fibonacci'` and `'camarilla'`
          */

package/es-modules/Stock/Indicators/SMA/SMAIndicator.js

@@ -302,7 +302,7 @@ SMAIndicator.defaultOptions = merge(LineSeries.defaultOptions, {
      */
     compareToMain: false,
     /**
-     * Paramters used in calculation of regression series' points.
+     * Parameters used in calculation of regression series' points.
      */
     params: {
         /**

package/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js

@@ -9,7 +9,6 @@
 import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 const { atr: ATRIndicator, sma: SMAIndicator } = SeriesRegistry.seriesTypes;
 import U from '../../../Core/Utilities.js';
-import StockChart from '../../../Core/Chart/StockChart.js';
 const { addEvent, correctFloat, isArray, extend, merge, objectEach } = U;
 /* *
  *
@@ -51,7 +50,7 @@ class SupertrendIndicator extends SMAIndicator {
         const indicator = this;
         super.init.apply(indicator, arguments);
         // Only after series are linked add some additional logic/properties.
-        const unbinder = addEvent(StockChart, 'afterLinkSeries', () => {
+        const unbinder = addEvent(this.chart.constructor, 'afterLinkSeries', () => {
             // Protection for a case where the indicator is being updated,
             // for a brief moment the indicator is deleted.
             if (indicator.options) {
@@ -80,7 +79,7 @@ class SupertrendIndicator extends SMAIndicator {
             }
         }, 
         // Sorted supertrend points array
-        groupedPoitns = {
+        groupedPoints = {
             top: [],
             bottom: [],
             intersect: [] // Change trend line points
@@ -116,7 +115,7 @@ class SupertrendIndicator extends SMAIndicator {
         prevMainPoint, prevPrevMainPoint, 
         // Used when particular point color is set
         pointColor, 
-        // Temporary points that fill groupedPoitns array
+        // Temporary points that fill groupedPoints array
         newPoint, newNextPoint, indicPointsLen = indicPoints.length;
         // Loop which sort supertrend points
         while (indicPointsLen--) {
@@ -187,19 +186,19 @@ class SupertrendIndicator extends SMAIndicator {
                     nextPoint.y >= nextMainPoint.close) {
                     point.color = (pointColor || indicOptions.fallingTrendColor ||
                         indicOptions.color);
-                    groupedPoitns.top.push(newPoint);
+                    groupedPoints.top.push(newPoint);
                 }
                 else if (point.y < mainPoint.close &&
                     nextPoint.y < nextMainPoint.close) {
                     point.color = (pointColor || indicOptions.risingTrendColor ||
                         indicOptions.color);
-                    groupedPoitns.bottom.push(newPoint);
+                    groupedPoints.bottom.push(newPoint);
                 }
                 else {
-                    groupedPoitns.intersect.push(newPoint);
-                    groupedPoitns.intersect.push(newNextPoint);
+                    groupedPoints.intersect.push(newPoint);
+                    groupedPoints.intersect.push(newNextPoint);
                     // Additional null point to make a gap in line
-                    groupedPoitns.intersect.push(merge(newNextPoint, {
+                    groupedPoints.intersect.push(merge(newNextPoint, {
                         isNull: true
                     }));
                     if (point.y >= mainPoint.close &&
@@ -208,8 +207,8 @@ class SupertrendIndicator extends SMAIndicator {
                             indicOptions.color);
                         nextPoint.color = (pointColor || indicOptions.risingTrendColor ||
                             indicOptions.color);
-                        groupedPoitns.top.push(newPoint);
-                        groupedPoitns.top.push(merge(newNextPoint, {
+                        groupedPoints.top.push(newPoint);
+                        groupedPoints.top.push(merge(newNextPoint, {
                             isNull: true
                         }));
                     }
@@ -219,8 +218,8 @@ class SupertrendIndicator extends SMAIndicator {
                             indicOptions.color);
                         nextPoint.color = (pointColor || indicOptions.fallingTrendColor ||
                             indicOptions.color);
-                        groupedPoitns.bottom.push(newPoint);
-                        groupedPoitns.bottom.push(merge(newNextPoint, {
+                        groupedPoints.bottom.push(newPoint);
+                        groupedPoints.bottom.push(merge(newNextPoint, {
                             isNull: true
                         }));
                     }
@@ -230,17 +229,17 @@ class SupertrendIndicator extends SMAIndicator {
                 if (point.y >= mainPoint.close) {
                     point.color = (pointColor || indicOptions.fallingTrendColor ||
                         indicOptions.color);
-                    groupedPoitns.top.push(newPoint);
+                    groupedPoints.top.push(newPoint);
                 }
                 else {
                     point.color = (pointColor || indicOptions.risingTrendColor ||
                         indicOptions.color);
-                    groupedPoitns.bottom.push(newPoint);
+                    groupedPoints.bottom.push(newPoint);
                 }
             }
         }
         // Generate lines:
-        objectEach(groupedPoitns, function (values, lineName) {
+        objectEach(groupedPoints, function (values, lineName) {
             indicator.points = values;
             indicator.options = merge(supertrendLineOptions[lineName].styles, gappedExtend);
             indicator.graph = indicator['graph' + lineName + 'Line'];
@@ -368,7 +367,7 @@ class SupertrendIndicator extends SMAIndicator {
  */
 SupertrendIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
     /**
-     * Paramters used in calculation of Supertrend indicator series points.
+     * Parameters used in calculation of Supertrend indicator series points.
      *
      * @excluding index
      */

package/es-modules/Stock/Indicators/VBP/VBPIndicator.js

@@ -18,7 +18,6 @@ const { noop } = H;
 import SeriesRegistry from '../../../Core/Series/SeriesRegistry.js';
 const { column: { prototype: columnProto }, sma: SMAIndicator } = SeriesRegistry.seriesTypes;
 import U from '../../../Core/Utilities.js';
-import StockChart from '../../../Core/Chart/StockChart.js';
 const { addEvent, arrayMax, arrayMin, correctFloat, defined, error, extend, isArray, merge } = U;
 /* *
  *
@@ -79,7 +78,7 @@ class VBPIndicator extends SMAIndicator {
         delete options.data;
         super.init.apply(indicator, arguments);
         // Only after series are linked add some additional logic/properties.
-        const unbinder = addEvent(StockChart, 'afterLinkSeries', function () {
+        const unbinder = addEvent(this.chart.constructor, 'afterLinkSeries', function () {
             // Protection for a case where the indicator is being updated,
             // for a brief moment the indicator is deleted.
             if (indicator.options) {
@@ -293,7 +292,7 @@ class VBPIndicator extends SMAIndicator {
             yData: yData
         };
     }
-    // Specifing where each zone should start ans end
+    // Specifying where each zone should start ans end
     specifyZones(isOHLC, xValues, yValues, ranges, volumeSeries) {
         const indicator = this, rangeExtremes = (isOHLC ? arrayExtremesOHLC(yValues) : false), zoneStarts = indicator.zoneStarts = [], priceZones = [];
         let lowRange = rangeExtremes ?
@@ -345,7 +344,7 @@ class VBPIndicator extends SMAIndicator {
         // Checks if each point has a corresponding volume value
         if (abs(baseSeriesLength - volumeSeriesLength)) {
             // If the first point don't have volume, add 0 value at the
-            // beggining of the volume array
+            // beginning of the volume array
             if (xValues[0] !== volumeXData[0]) {
                 volumeYData.unshift(0);
             }
@@ -404,7 +403,7 @@ class VBPIndicator extends SMAIndicator {
         });
         return priceZones;
     }
-    // Function responsoble for drawing additional lines indicating zones
+    // Function responsible for drawing additional lines indicating zones
     drawZones(chart, yAxis, zonesValues, zonesStyles) {
         const indicator = this, renderer = chart.renderer, leftLinePos = 0, rightLinePos = chart.plotWidth, verticalOffset = chart.plotTop;
         let zoneLinesSVG = indicator.zoneLinesSVG, zoneLinesPath = [], verticalLinePos;

package/es-modules/Stock/Indicators/WilliamsR/WilliamsRIndicator.js

@@ -91,7 +91,7 @@ class WilliamsRIndicator extends SMAIndicator {
  */
 WilliamsRIndicator.defaultOptions = merge(SMAIndicator.defaultOptions, {
     /**
-     * Paramters used in calculation of Williams %R series points.
+     * Parameters used in calculation of Williams %R series points.
      * @excluding index
      */
     params: {

package/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js

@@ -38,7 +38,7 @@ class ZigzagIndicator extends SMAIndicator {
             'high': 1 - deviation
         }, xVal = series.xData, yVal = series.yData, yValLen = yVal ? yVal.length : 0, zigzag = [], xData = [], yData = [];
         let i, j, zigzagPoint, directionUp, exitLoop = false, yIndex = false;
-        // Exit if not enught points or no low or high values
+        // Exit if not enough points or no low or high values
         if (!xVal || xVal.length <= 1 ||
             (yValLen &&
                 (typeof yVal[0][lowIndex] === 'undefined' ||
@@ -50,7 +50,7 @@ class ZigzagIndicator extends SMAIndicator {
         // Search for a second zigzag point candidate,
         // this will also set first zigzag point
         for (i = 1; i < yValLen; i++) {
-            // requried change to go down
+            // required change to go down
             if (yVal[i][lowIndex] <= firstZigzagHigh * deviations.high) {
                 zigzag.push([xVal[0], firstZigzagHigh]);
                 // second zigzag point candidate
@@ -58,7 +58,7 @@ class ZigzagIndicator extends SMAIndicator {
                 // next line will be going up
                 directionUp = true;
                 exitLoop = true;
-                // requried change to go up
+                // required change to go up
             }
             else if (yVal[i][highIndex] >= firstZigzagLow * deviations.low) {
                 zigzag.push([xVal[0], firstZigzagLow]);
@@ -82,7 +82,7 @@ class ZigzagIndicator extends SMAIndicator {
                 if (yVal[i][lowIndex] <= zigzagPoint[1]) {
                     zigzagPoint = [xVal[i], yVal[i][lowIndex]];
                 }
-                // requried change to go down -> new zigzagpoint and
+                // required change to go down -> new zigzagpoint and
                 // direction change
                 if (yVal[i][highIndex] >=
                     zigzagPoint[1] * deviations.low) {
@@ -94,7 +94,7 @@ class ZigzagIndicator extends SMAIndicator {
                 if (yVal[i][highIndex] >= zigzagPoint[1]) {
                     zigzagPoint = [xVal[i], yVal[i][highIndex]];
                 }
-                // requried change to go down -> new zigzagpoint and
+                // required change to go down -> new zigzagpoint and
                 // direction change
                 if (yVal[i][lowIndex] <=
                     zigzagPoint[1] * deviations.high) {

package/es-modules/Stock/Navigator/ChartNavigatorComposition.js

@@ -0,0 +1,188 @@
+/* *
+ *
+ *  (c) 2010-2024 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import H from '../../Core/Globals.js';
+const { isTouchDevice } = H;
+import U from '../../Core/Utilities.js';
+const { addEvent, merge, pick } = U;
+/* *
+ *
+ *  Constants
+ *
+ * */
+const composedMembers = [];
+/* *
+ *
+ *  Variables
+ *
+ * */
+let NavigatorConstructor;
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * @private
+ */
+function compose(ChartClass, NavigatorClass) {
+    if (U.pushUnique(composedMembers, ChartClass)) {
+        const chartProto = ChartClass.prototype;
+        NavigatorConstructor = NavigatorClass;
+        chartProto.callbacks.push(onChartCallback);
+        addEvent(ChartClass, 'afterAddSeries', onChartAfterAddSeries);
+        addEvent(ChartClass, 'afterSetChartSize', onChartAfterSetChartSize);
+        addEvent(ChartClass, 'afterUpdate', onChartAfterUpdate);
+        addEvent(ChartClass, 'beforeRender', onChartBeforeRender);
+        addEvent(ChartClass, 'beforeShowResetZoom', onChartBeforeShowResetZoom);
+        addEvent(ChartClass, 'update', onChartUpdate);
+    }
+}
+/**
+ * Handle adding new series.
+ * @private
+ */
+function onChartAfterAddSeries() {
+    if (this.navigator) {
+        // Recompute which series should be shown in navigator, and add them
+        this.navigator.setBaseSeries(null, false);
+    }
+}
+/**
+ * For stock charts, extend the Chart.setChartSize method so that we can set the
+ * final top position of the navigator once the height of the chart, including
+ * the legend, is determined. #367. We can't use Chart.getMargins, because
+ * labels offsets are not calculated yet.
+ * @private
+ */
+function onChartAfterSetChartSize() {
+    const legend = this.legend, navigator = this.navigator;
+    let legendOptions, xAxis, yAxis;
+    if (navigator) {
+        legendOptions = legend && legend.options;
+        xAxis = navigator.xAxis;
+        yAxis = navigator.yAxis;
+        const { scrollbarHeight, scrollButtonSize } = navigator;
+        // Compute the top position
+        if (this.inverted) {
+            navigator.left = navigator.opposite ?
+                this.chartWidth - scrollbarHeight -
+                    navigator.height :
+                this.spacing[3] + scrollbarHeight;
+            navigator.top = this.plotTop + scrollButtonSize;
+        }
+        else {
+            navigator.left = pick(xAxis.left, this.plotLeft + scrollButtonSize);
+            navigator.top = navigator.navigatorOptions.top ||
+                this.chartHeight -
+                    navigator.height -
+                    scrollbarHeight -
+                    (this.scrollbar?.options.margin || 0) -
+                    this.spacing[2] -
+                    (this.rangeSelector && this.extraBottomMargin ?
+                        this.rangeSelector.getHeight() :
+                        0) -
+                    ((legendOptions &&
+                        legendOptions.verticalAlign === 'bottom' &&
+                        legendOptions.layout !== 'proximate' && // #13392
+                        legendOptions.enabled &&
+                        !legendOptions.floating) ?
+                        legend.legendHeight +
+                            pick(legendOptions.margin, 10) :
+                        0) -
+                    (this.titleOffset ? this.titleOffset[2] : 0);
+        }
+        if (xAxis && yAxis) { // false if navigator is disabled (#904)
+            if (this.inverted) {
+                xAxis.options.left = yAxis.options.left = navigator.left;
+            }
+            else {
+                xAxis.options.top = yAxis.options.top = navigator.top;
+            }
+            xAxis.setAxisSize();
+            yAxis.setAxisSize();
+        }
+    }
+}
+/**
+ * Initialize navigator, if no scrolling exists yet.
+ * @private
+ */
+function onChartAfterUpdate(event) {
+    if (!this.navigator && !this.scroller &&
+        (this.options.navigator.enabled ||
+            this.options.scrollbar.enabled)) {
+        this.scroller = this.navigator = new NavigatorConstructor(this);
+        if (pick(event.redraw, true)) {
+            this.redraw(event.animation); // #7067
+        }
+    }
+}
+/**
+ * Initialize navigator for stock charts
+ * @private
+ */
+function onChartBeforeRender() {
+    const options = this.options;
+    if (options.navigator.enabled ||
+        options.scrollbar.enabled) {
+        this.scroller = this.navigator = new NavigatorConstructor(this);
+    }
+}
+/**
+ * For Stock charts. For x only zooming, do not to create the zoom button
+ * because X axis zooming is already allowed by the Navigator and Range
+ * selector. (#9285)
+ * @private
+ */
+function onChartBeforeShowResetZoom() {
+    const chartOptions = this.options, navigator = chartOptions.navigator, rangeSelector = chartOptions.rangeSelector;
+    if (((navigator && navigator.enabled) ||
+        (rangeSelector && rangeSelector.enabled)) &&
+        ((!isTouchDevice &&
+            this.zooming.type === 'x') ||
+            (isTouchDevice && this.zooming.pinchType === 'x'))) {
+        return false;
+    }
+}
+/**
+ * @private
+ */
+function onChartCallback(chart) {
+    const navigator = chart.navigator;
+    // Initialize the navigator
+    if (navigator && chart.xAxis[0]) {
+        const extremes = chart.xAxis[0].getExtremes();
+        navigator.render(extremes.min, extremes.max);
+    }
+}
+/**
+ * Merge options, if no scrolling exists yet
+ * @private
+ */
+function onChartUpdate(e) {
+    const navigatorOptions = (e.options.navigator || {}), scrollbarOptions = (e.options.scrollbar || {});
+    if (!this.navigator && !this.scroller &&
+        (navigatorOptions.enabled || scrollbarOptions.enabled)) {
+        merge(true, this.options.navigator, navigatorOptions);
+        merge(true, this.options.scrollbar, scrollbarOptions);
+        delete e.options.navigator;
+        delete e.options.scrollbar;
+    }
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+const ChartNavigatorComposition = {
+    compose
+};
+export default ChartNavigatorComposition;