highcharts 10.0.0 → 10.2.1

package/es-modules/Extensions/Annotations/MockPoint.js

@@ -4,48 +4,15 @@
  *
  * */
 'use strict';
-import Series from '../../Core/Series/Series.js';
-/**
- * @private
- * @interface Highcharts.AnnotationMockLabelOptionsObject
- */ /**
-* Point instance of the point.
-* @name Highcharts.AnnotationMockLabelOptionsObject#point
-* @type {Highcharts.AnnotationMockPoint}
-*/ /**
-* X value translated to x axis scale.
-* @name Highcharts.AnnotationMockLabelOptionsObject#x
-* @type {number|null}
-*/ /**
-* Y value translated to y axis scale.
-* @name Highcharts.AnnotationMockLabelOptionsObject#y
-* @type {number|null}
-*/
-/**
- * A mock series instance imitating a real series from a real point.
- * @private
- * @interface Highcharts.AnnotationMockSeries
- */ /**
-* Whether a series is visible.
-* @name Highcharts.AnnotationMockSeries#visible
-* @type {boolean}
-*/ /**
-* A chart instance.
-* @name Highcharts.AnnotationMockSeries#chart
-* @type {Highcharts.Chart}
-*/ /**
-* @name Highcharts.AnnotationMockSeries#getPlotBox
-* @type {Function}
-*/
-/**
- * Indicates if this is a mock point for an annotation.
- * @name Highcharts.Point#mock
- * @type {boolean|undefined}
- */
+import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
+var seriesProto = SeriesRegistry.series.prototype;
 import U from '../../Core/Utilities.js';
-var defined = U.defined, extend = U.extend, fireEvent = U.fireEvent;
-import Axis from '../../Core/Axis/Axis.js';
-/* eslint-disable no-invalid-this, valid-jsdoc */
+var defined = U.defined, fireEvent = U.fireEvent;
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * A trimmed point object which imitates {@link Highchart.Point} class. It is
  * created when there is a need of pointing to some chart's position using axis
@@ -69,14 +36,14 @@ import Axis from '../../Core/Axis/Axis.js';
  * The options object.
  */
 var MockPoint = /** @class */ (function () {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
     function MockPoint(chart, target, options) {
-        this.isInside = void 0;
-        this.negative = void 0;
         this.plotX = void 0;
         this.plotY = void 0;
-        this.ttBelow = void 0;
-        this.x = void 0;
-        this.y = void 0;
         /* *
          *
          * Functions
@@ -98,7 +65,7 @@ var MockPoint = /** @class */ (function () {
         this.series = {
             visible: true,
             chart: chart,
-            getPlotBox: Series.prototype.getPlotBox
+            getPlotBox: seriesProto.getPlotBox
         };
         /**
          * @name Annotation.AnnotationMockPoint#target
@@ -147,6 +114,11 @@ var MockPoint = /** @class */ (function () {
          */
         this.applyOptions(this.getOptions());
     }
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
     /**
      * Create a mock point from a real Highcharts point.
      *
@@ -175,20 +147,21 @@ var MockPoint = /** @class */ (function () {
      * @param {Highcharts.AnnotationPointType} point
      *
      * @param {boolean} [paneCoordinates]
-     *        whether the pixel position should be relative
+     *        Whether the pixel position should be relative
      *
      * @return {Highcharts.PositionObject} pixel position
      */
     MockPoint.pointToPixels = function (point, paneCoordinates) {
-        var series = point.series, chart = series.chart, x = point.plotX, y = point.plotY, plotBox;
+        var series = point.series, chart = series.chart;
+        var x = point.plotX || 0, y = point.plotY || 0, plotBox;
         if (chart.inverted) {
             if (point.mock) {
                 x = point.plotY;
                 y = point.plotX;
             }
             else {
-                x = chart.plotWidth - point.plotY;
-                y = chart.plotHeight - point.plotX;
+                x = chart.plotWidth - (point.plotY || 0);
+                y = chart.plotHeight - (point.plotX || 0);
             }
         }
         if (series && !paneCoordinates) {
@@ -220,26 +193,6 @@ var MockPoint = /** @class */ (function () {
             yAxis: point.series.yAxis
         };
     };
-    /**
-     * Check if the point has dynamic options.
-     * @private
-     * @return {boolean}
-     * A positive flag if the point has dynamic options.
-     */
-    MockPoint.prototype.hasDynamicOptions = function () {
-        return typeof this.options === 'function';
-    };
-    /**
-     * Get the point's options.
-     * @private
-     * @return {Highcharts.AnnotationMockPointOptionsObject}
-     * The mock point's options.
-     */
-    MockPoint.prototype.getOptions = function () {
-        return this.hasDynamicOptions() ?
-            this.options(this.target) :
-            this.options;
-    };
     /**
      * Apply options for the point.
      * @private
@@ -251,42 +204,12 @@ var MockPoint = /** @class */ (function () {
         this.setAxis(options, 'y');
         this.refresh();
     };
-    /**
-     * Set x or y axis.
-     * @private
-     * @param {Highcharts.AnnotationMockPointOptionsObject} options
-     * @param {string} xOrY
-     * 'x' or 'y' string literal
-     */
-    MockPoint.prototype.setAxis = function (options, xOrY) {
-        var axisName = (xOrY + 'Axis'), axisOptions = options[axisName], chart = this.series.chart;
-        this.series[axisName] =
-            axisOptions instanceof Axis ?
-                axisOptions :
-                defined(axisOptions) ?
-                    (chart[axisName][axisOptions] ||
-                        chart.get(axisOptions)) :
-                    null;
-    };
-    /**
-     * Transform the mock point to an anchor (relative position on the chart).
-     * @private
-     * @return {Array<number>}
-     * A quadruple of numbers which denotes x, y, width and height of the box
-     **/
-    MockPoint.prototype.toAnchor = function () {
-        var anchor = [this.plotX, this.plotY, 0, 0];
-        if (this.series.chart.inverted) {
-            anchor[0] = this.plotY;
-            anchor[1] = this.plotX;
-        }
-        return anchor;
-    };
     /**
      * Returns a label config object - the same as
      * Highcharts.Point.prototype.getLabelConfig
      * @private
-     * @return {Highcharts.AnnotationMockLabelOptionsObject} the point's label config
+     * @return {Highcharts.AnnotationMockLabelOptionsObject}
+     * The point's label config
      */
     MockPoint.prototype.getLabelConfig = function () {
         return {
@@ -295,6 +218,26 @@ var MockPoint = /** @class */ (function () {
             point: this
         };
     };
+    /**
+     * Get the point's options.
+     * @private
+     * @return {Highcharts.AnnotationMockPointOptionsObject}
+     * The mock point's options.
+     */
+    MockPoint.prototype.getOptions = function () {
+        return this.hasDynamicOptions() ?
+            this.options(this.target) :
+            this.options;
+    };
+    /**
+     * Check if the point has dynamic options.
+     * @private
+     * @return {boolean}
+     * A positive flag if the point has dynamic options.
+     */
+    MockPoint.prototype.hasDynamicOptions = function () {
+        return typeof this.options === 'function';
+    };
     /**
      * Check if the point is inside its pane.
      * @private
@@ -343,26 +286,30 @@ var MockPoint = /** @class */ (function () {
         this.isInside = this.isInsidePlot();
     };
     /**
-     * Translate the point.
-     *
+     * Refresh point options based on its plot coordinates.
      * @private
-     *
-     * @param {number|undefined} cx
-     * Origin x transformation.
-     *
-     * @param {number|undefined} cy
-     * Origin y transformation.
-     *
-     * @param {number} dx
-     * Translation for x coordinate.
-     *
-     * @param {number} dy
-     * Translation for y coordinate.
-     **/
-    MockPoint.prototype.translate = function (_cx, _cy, dx, dy) {
+     */
+    MockPoint.prototype.refreshOptions = function () {
+        var series = this.series, xAxis = series.xAxis, yAxis = series.yAxis;
+        this.x = this.options.x = xAxis ?
+            this.options.x = xAxis.toValue(this.plotX, true) :
+            this.plotX;
+        this.y = this.options.y = yAxis ?
+            yAxis.toValue(this.plotY, true) :
+            this.plotY;
+    };
+    /**
+     * Rotate the point.
+     * @private
+     * @param {number} cx origin x rotation
+     * @param {number} cy origin y rotation
+     * @param {number} radians
+     */
+    MockPoint.prototype.rotate = function (cx, cy, radians) {
         if (!this.hasDynamicOptions()) {
-            this.plotX += dx;
-            this.plotY += dy;
+            var cos = Math.cos(radians), sin = Math.sin(radians), x = this.plotX - cx, y = this.plotY - cy, tx = x * cos - y * sin, ty = x * sin + y * cos;
+            this.plotX = tx + cx;
+            this.plotY = ty + cy;
             this.refreshOptions();
         }
     };
@@ -392,37 +339,155 @@ var MockPoint = /** @class */ (function () {
         }
     };
     /**
-     * Rotate the point.
+     * Set x or y axis.
      * @private
-     * @param {number} cx origin x rotation
-     * @param {number} cy origin y rotation
-     * @param {number} radians
+     * @param {Highcharts.AnnotationMockPointOptionsObject} options
+     * @param {string} xOrY
+     * 'x' or 'y' string literal
      */
-    MockPoint.prototype.rotate = function (cx, cy, radians) {
-        if (!this.hasDynamicOptions()) {
-            var cos = Math.cos(radians), sin = Math.sin(radians), x = this.plotX, y = this.plotY, tx = void 0, ty = void 0;
-            x -= cx;
-            y -= cy;
-            tx = x * cos - y * sin;
-            ty = x * sin + y * cos;
-            this.plotX = tx + cx;
-            this.plotY = ty + cy;
-            this.refreshOptions();
+    MockPoint.prototype.setAxis = function (options, xOrY) {
+        var axisName = (xOrY + 'Axis'), axisOptions = options[axisName], chart = this.series.chart;
+        this.series[axisName] =
+            typeof axisOptions === 'object' ?
+                axisOptions :
+                defined(axisOptions) ?
+                    (chart[axisName][axisOptions] ||
+                        // @todo v--- (axisName)[axisOptions] ?
+                        chart.get(axisOptions)) :
+                    null;
+    };
+    /**
+     * Transform the mock point to an anchor (relative position on the chart).
+     * @private
+     * @return {Array<number>}
+     * A quadruple of numbers which denotes x, y, width and height of the box
+     **/
+    MockPoint.prototype.toAnchor = function () {
+        var anchor = [this.plotX, this.plotY, 0, 0];
+        if (this.series.chart.inverted) {
+            anchor[0] = this.plotY;
+            anchor[1] = this.plotX;
         }
+        return anchor;
     };
     /**
-     * Refresh point options based on its plot coordinates.
+     * Translate the point.
+     *
      * @private
-     */
-    MockPoint.prototype.refreshOptions = function () {
-        var series = this.series, xAxis = series.xAxis, yAxis = series.yAxis;
-        this.x = this.options.x = xAxis ?
-            this.options.x = xAxis.toValue(this.plotX, true) :
-            this.plotX;
-        this.y = this.options.y = yAxis ?
-            yAxis.toValue(this.plotY, true) :
-            this.plotY;
+     *
+     * @param {number|undefined} cx
+     * Origin x transformation.
+     *
+     * @param {number|undefined} cy
+     * Origin y transformation.
+     *
+     * @param {number} dx
+     * Translation for x coordinate.
+     *
+     * @param {number} dy
+     * Translation for y coordinate.
+     **/
+    MockPoint.prototype.translate = function (_cx, _cy, dx, dy) {
+        if (!this.hasDynamicOptions()) {
+            this.plotX += dx;
+            this.plotY += dy;
+            this.refreshOptions();
+        }
     };
     return MockPoint;
 }());
+/* *
+ *
+ *  Default Export
+ *
+ * */
 export default MockPoint;
+/* *
+ *
+ *  API Declarations
+ *
+ * */
+/**
+ * @private
+ * @interface Highcharts.AnnotationMockLabelOptionsObject
+ */ /**
+* Point instance of the point.
+* @name Highcharts.AnnotationMockLabelOptionsObject#point
+* @type {Highcharts.AnnotationMockPoint}
+*/ /**
+* X value translated to x axis scale.
+* @name Highcharts.AnnotationMockLabelOptionsObject#x
+* @type {number|null}
+*/ /**
+* Y value translated to y axis scale.
+* @name Highcharts.AnnotationMockLabelOptionsObject#y
+* @type {number|null}
+*/
+/**
+ * Object of shape point.
+ *
+ * @interface Highcharts.AnnotationMockPointOptionsObject
+ */ /**
+* The x position of the point. Units can be either in axis
+* or chart pixel coordinates.
+*
+* @type      {number}
+* @name      Highcharts.AnnotationMockPointOptionsObject.x
+*/ /**
+* The y position of the point. Units can be either in axis
+* or chart pixel coordinates.
+*
+* @type      {number}
+* @name      Highcharts.AnnotationMockPointOptionsObject.y
+*/ /**
+* This number defines which xAxis the point is connected to.
+* It refers to either the axis id or the index of the axis in
+* the xAxis array. If the option is not configured or the axis
+* is not found the point's x coordinate refers to the chart
+* pixels.
+*
+* @type      {number|string|null}
+* @name      Highcharts.AnnotationMockPointOptionsObject.xAxis
+*/ /**
+* This number defines which yAxis the point is connected to.
+* It refers to either the axis id or the index of the axis in
+* the yAxis array. If the option is not configured or the axis
+* is not found the point's y coordinate refers to the chart
+* pixels.
+*
+* @type      {number|string|null}
+* @name      Highcharts.AnnotationMockPointOptionsObject.yAxis
+*/
+/**
+ * Callback function that returns the annotation shape point.
+ *
+ * @callback Highcharts.AnnotationMockPointFunction
+ *
+ * @param  {Highcharts.Annotation} annotation
+ *         An annotation instance.
+ *
+ * @return {Highcharts.AnnotationMockPointOptionsObject}
+ *         Annotations shape point.
+ */
+/**
+ * A mock series instance imitating a real series from a real point.
+ * @private
+ * @interface Highcharts.AnnotationMockSeries
+ */ /**
+* Whether a series is visible.
+* @name Highcharts.AnnotationMockSeries#visible
+* @type {boolean}
+*/ /**
+* A chart instance.
+* @name Highcharts.AnnotationMockSeries#chart
+* @type {Highcharts.Chart}
+*/ /**
+* @name Highcharts.AnnotationMockSeries#getPlotBox
+* @type {Function}
+*/
+/**
+ * Indicates if this is a mock point for an annotation.
+ * @name Highcharts.Point#mock
+ * @type {boolean|undefined}
+ */
+(''); // keeps doclets above in JS file