scichart 2.2.2416 → 3.0.0-beta.224

package/Core/Mouse/MouseManager.js

@@ -3,8 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MouseManager = void 0;
 var ModifierMouseArgs_1 = require("../../Charting/ChartModifiers/ModifierMouseArgs");
 var SciChartSurfaceBase_1 = require("../../Charting/Visuals/SciChartSurfaceBase");
+var DpiHelper_1 = require("../../Charting/Visuals/TextureManager/DpiHelper");
 var array_1 = require("../../utils/array");
 var Guard_1 = require("../Guard");
+var EMouseEventType;
+(function (EMouseEventType) {
+    EMouseEventType[EMouseEventType["Move"] = 0] = "Move";
+    EMouseEventType[EMouseEventType["Down"] = 1] = "Down";
+    EMouseEventType[EMouseEventType["Up"] = 2] = "Up";
+    EMouseEventType[EMouseEventType["Wheel"] = 3] = "Wheel";
+    EMouseEventType[EMouseEventType["Click"] = 4] = "Click";
+    EMouseEventType[EMouseEventType["Leave"] = 5] = "Leave";
+    EMouseEventType[EMouseEventType["Enter"] = 6] = "Enter";
+    EMouseEventType[EMouseEventType["Cancel"] = 7] = "Cancel";
+    EMouseEventType[EMouseEventType["Drop"] = 8] = "Drop";
+})(EMouseEventType || (EMouseEventType = {}));
 /**
  * The MouseManager handles mouse and touch events from any {@link IEventListenerSource} and publishes events to any {@link IReceiveMouseEvents}
  * type
@@ -17,6 +30,10 @@ var MouseManager = /** @class */ (function () {
      * @param target The target {@link SciChartSurfaceBase} that we are listening to events on
      */
     function MouseManager(target) {
+        /**
+         * For subCharts - to track if the mousepointer is over the subChart, so we can fake Enter and Leave events
+         */
+        this.isOver = false;
         // We allow null target for testing purpose
         this.sciChartSurface = target;
         this.onPointerMove = this.onPointerMove.bind(this);
@@ -28,6 +45,7 @@ var MouseManager = /** @class */ (function () {
         this.onMouseEnter = this.onMouseEnter.bind(this);
         this.onContextMenu = this.onContextMenu.bind(this);
         this.onPointerCancel = this.onPointerCancel.bind(this);
+        this.onDrop = this.onDrop.bind(this);
     }
     /**
      * Used internally - subscribes to mouse events on the source
@@ -46,6 +64,7 @@ var MouseManager = /** @class */ (function () {
         source.addEventListener("mouseleave", this.onMouseLeave);
         source.addEventListener("mouseenter", this.onMouseEnter);
         source.addEventListener("contextmenu", this.onContextMenu);
+        source.addEventListener("drop", this.onDrop);
     };
     /**
      * Used internally - unsubscribes from mouse events
@@ -61,6 +80,7 @@ var MouseManager = /** @class */ (function () {
             this.canvas.removeEventListener("mouseleave", this.onMouseLeave);
             this.canvas.removeEventListener("mouseenter", this.onMouseEnter);
             this.canvas.removeEventListener("contextmenu", this.onContextMenu);
+            this.canvas.removeEventListener("drop", this.onDrop);
         }
         this.canvas = null;
     };
@@ -137,6 +157,10 @@ var MouseManager = /** @class */ (function () {
         // prevent context menu on chart elements
         event.preventDefault();
     };
+    MouseManager.prototype.onDrop = function (event) {
+        var modifierEvent = ModifierMouseArgs_1.ModifierMouseArgs.fromMouseEvent(event);
+        this.modifierDrop(modifierEvent);
+    };
     MouseManager.prototype.modifierPointerCancel = function (args) {
         var _this = this;
         if (args.isMaster) {
@@ -150,12 +174,14 @@ var MouseManager = /** @class */ (function () {
             }
         });
         if (args.isMaster) {
+            var masterData_1 = this.getMasterData(this.sciChartSurface, args);
             this.chartModifierGroups.forEach(function (modifierGroup) {
                 _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                    var argsCopy = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                    var argsCopy = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_1);
                     scs.mouseManager.modifierPointerCancel(argsCopy);
                 });
             });
+            this.updateSubCharts(args, EMouseEventType.Cancel);
         }
     };
     /**
@@ -184,12 +210,14 @@ var MouseManager = /** @class */ (function () {
             }
         });
         if (args.isMaster) {
+            var masterData_2 = this.getMasterData(this.sciChartSurface, args);
             this.chartModifierGroups.forEach(function (modifierGroup) {
                 _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_2);
                     scs.mouseManager.modifierMouseMove(args2);
                 });
             });
+            this.updateSubCharts(args, EMouseEventType.Move);
         }
     };
     /**
@@ -214,43 +242,47 @@ var MouseManager = /** @class */ (function () {
                 }
             });
             if (args.isMaster) {
+                var masterData_3 = _this.getMasterData(_this.sciChartSurface, args);
                 _this.chartModifierGroups.forEach(function (modifierGroup) {
                     _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                        var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                        var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_3);
                         scs.mouseManager.modifierMouseDown(args2);
                     });
                 });
+                _this.updateSubCharts(args, EMouseEventType.Down);
             }
         };
-        var selectAnnotationAndUpdateModifiers = function (_scs) {
-            _scs.adornerLayer.selectAnnotation(args);
-            var currentAnnotation = _scs.adornerLayer.selectedAnnotation;
-            if (currentAnnotation) {
-                if (currentAnnotation.onDragStarted(args)) {
-                    _this.modifierMouseMove(args);
+        if (args.isMaster) {
+            var selectAnnotationAndUpdateModifiers = function (_scs) {
+                _scs.adornerLayer.selectAnnotation(args);
+                var currentAnnotation = _scs.adornerLayer.selectedAnnotation;
+                if (currentAnnotation) {
+                    if (currentAnnotation.onDragStarted(args)) {
+                        _this.modifierMouseMove(args);
+                    }
                 }
-            }
-            else {
-                updateModifiers();
-            }
-        };
-        // Annotation Adorners
-        if (this.sciChartSurface.surfaceType === SciChartSurfaceBase_1.ESurfaceType.SciChartSurfaceType) {
-            var scs = this.sciChartSurface;
-            var currentAnnotation = scs.adornerLayer.selectedAnnotation;
-            if (currentAnnotation) {
-                var isDraggingStarted = currentAnnotation.onDragStarted(args);
-                if (!isDraggingStarted) {
+                else {
+                    updateModifiers();
+                }
+            };
+            // Annotation Adorners
+            if (this.sciChartSurface.surfaceType === SciChartSurfaceBase_1.ESurfaceType.SciChartSurfaceType) {
+                var scs = this.sciChartSurface;
+                var currentAnnotation = scs.adornerLayer.selectedAnnotation;
+                if (currentAnnotation) {
+                    var isDraggingStarted = currentAnnotation.onDragStarted(args);
+                    if (!isDraggingStarted) {
+                        selectAnnotationAndUpdateModifiers(scs);
+                    }
+                }
+                else {
                     selectAnnotationAndUpdateModifiers(scs);
                 }
             }
             else {
-                selectAnnotationAndUpdateModifiers(scs);
+                updateModifiers();
             }
         }
-        else {
-            updateModifiers();
-        }
     };
     /**
      * Internal function called to route a mouse up event to all {@link sciChartSurface.chartModifiers}
@@ -282,12 +314,14 @@ var MouseManager = /** @class */ (function () {
             }
         });
         if (args.isMaster) {
+            var masterData_4 = this.getMasterData(this.sciChartSurface, args);
             this.chartModifierGroups.forEach(function (modifierGroup) {
                 _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_4);
                     scs.mouseManager.modifierMouseUp(args2);
                 });
             });
+            this.updateSubCharts(args, EMouseEventType.Up);
         }
     };
     /**
@@ -306,12 +340,14 @@ var MouseManager = /** @class */ (function () {
             }
         });
         if (args.isMaster) {
+            var masterData_5 = this.getMasterData(this.sciChartSurface, args);
             this.chartModifierGroups.forEach(function (modifierGroup) {
                 _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_5);
                     scs.mouseManager.modifierMouseWheel(args2);
                 });
             });
+            this.updateSubCharts(args, EMouseEventType.Wheel);
         }
     };
     /**
@@ -330,12 +366,14 @@ var MouseManager = /** @class */ (function () {
             }
         });
         if (args.isMaster) {
+            var masterData_6 = this.getMasterData(this.sciChartSurface, args);
             this.chartModifierGroups.forEach(function (modifierGroup) {
                 _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_6);
                     scs.mouseManager.modifierDoubleClick(args2);
                 });
             });
+            this.updateSubCharts(args, EMouseEventType.Click);
         }
     };
     /**
@@ -354,12 +392,14 @@ var MouseManager = /** @class */ (function () {
             }
         });
         if (args.isMaster) {
+            var masterData_7 = this.getMasterData(this.sciChartSurface, args);
             this.chartModifierGroups.forEach(function (modifierGroup) {
                 _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_7);
                     scs.mouseManager.modifierMouseLeave(args2);
                 });
             });
+            this.updateSubCharts(args, EMouseEventType.Leave);
         }
     };
     /**
@@ -378,14 +418,49 @@ var MouseManager = /** @class */ (function () {
             }
         });
         if (args.isMaster) {
+            var masterData_8 = this.getMasterData(this.sciChartSurface, args);
             this.chartModifierGroups.forEach(function (modifierGroup) {
                 _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
-                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect);
+                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_8);
                     scs.mouseManager.modifierMouseEnter(args2);
                 });
             });
+            this.updateSubCharts(args, EMouseEventType.Enter);
+        }
+    };
+    /**
+     * Internal function called to route a drop event to all {@link sciChartSurface.chartModifiers}
+     * @param args The {@link ModifierMouseArgs} to route
+     * @remarks Event routing stops if any event marks {@link ModifierMouseArgs.handled} as true. To override this,
+     * the user must set {@link ChartModifierBase.receiveHandledEvents} = true.
+     */
+    MouseManager.prototype.modifierDrop = function (args) {
+        var _this = this;
+        this.chartModifiers.forEach(function (cm) {
+            if (cm.canReceiveMouseEvents && (!args.handled || cm.receiveHandledEvents)) {
+                if (args.isMaster || (!args.isMaster && cm.modifierGroup === args.modifierGroup)) {
+                    cm.modifierDrop(args, _this.sciChartSurface);
+                }
+            }
+        });
+        if (args.isMaster) {
+            var masterData_9 = this.getMasterData(this.sciChartSurface, args);
+            this.chartModifierGroups.forEach(function (modifierGroup) {
+                _this.sciChartSurface.otherSurfaces.forEach(function (scs) {
+                    var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copy(args, modifierGroup, _this.sciChartSurface.seriesViewRect, scs.seriesViewRect, masterData_9);
+                    scs.mouseManager.modifierDrop(args2);
+                });
+            });
+            this.updateSubCharts(args, EMouseEventType.Drop);
         }
     };
+    /**
+     * Get data from the master surface which will be passed to other surfaces when modifierGroups are used.
+     * Use this if you want to use the data value from the master surface in the modifier on the other surfaces
+     */
+    MouseManager.prototype.getMasterData = function (sciChartSurface, args) {
+        return {};
+    };
     Object.defineProperty(MouseManager.prototype, "chartModifiers", {
         get: function () {
             return this.sciChartSurface.chartModifiers.asArray();
@@ -401,6 +476,100 @@ var MouseManager = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    MouseManager.prototype.updateSubCharts = function (args, eventType) {
+        var _this = this;
+        var subCharts = this.sciChartSurface.subCharts;
+        subCharts === null || subCharts === void 0 ? void 0 : subCharts.forEach(function (scs) {
+            var subEventType = eventType;
+            var _a = scs.padding, top = _a.top, left = _a.left, bottom = _a.bottom, right = _a.right;
+            var _b = args.mousePoint, x = _b.x, y = _b.y;
+            var xns = x / DpiHelper_1.DpiHelper.PIXEL_RATIO;
+            var yns = y / DpiHelper_1.DpiHelper.PIXEL_RATIO;
+            var _c = _this.sciChartSurface.renderSurface.viewportSize, width = _c.width, height = _c.height;
+            var wns = width / DpiHelper_1.DpiHelper.PIXEL_RATIO;
+            var hns = height / DpiHelper_1.DpiHelper.PIXEL_RATIO;
+            var isNowOver = left <= xns && xns <= wns - right && top <= yns && yns <= hns - bottom;
+            if (scs.mouseManager.isOver) {
+                if (!isNowOver) {
+                    scs.mouseManager.isOver = false;
+                    // Leaving to surface
+                    if (subEventType === EMouseEventType.Move) {
+                        var leaveArgs = new ModifierMouseArgs_1.ModifierMouseArgs(args.mousePoint, args);
+                        _this.processSubChartEvent(EMouseEventType.Leave, scs, leaveArgs, subCharts);
+                    }
+                    // If not over the subchart, don't process anything except cancellation events
+                    if (subEventType !== EMouseEventType.Cancel && subEventType !== EMouseEventType.Up) {
+                        subEventType = undefined;
+                    }
+                }
+            }
+            else {
+                if (isNowOver) {
+                    scs.mouseManager.isOver = true;
+                    // Entering from surface
+                    if (subEventType === EMouseEventType.Move) {
+                        var enterArgs = new ModifierMouseArgs_1.ModifierMouseArgs(args.mousePoint, args);
+                        _this.processSubChartEvent(EMouseEventType.Enter, scs, enterArgs, subCharts);
+                    }
+                }
+                else {
+                    // If not over the subchart, don't process anything except cancellation events
+                    if (subEventType !== EMouseEventType.Cancel && subEventType !== EMouseEventType.Up) {
+                        subEventType = undefined;
+                    }
+                }
+            }
+            if (subEventType !== undefined) {
+                _this.processSubChartEvent(subEventType, scs, args, subCharts);
+            }
+        });
+    };
+    MouseManager.prototype.processSubChartEvent = function (eventType, scs, args, subCharts) {
+        var _this = this;
+        this.callEvent(eventType, scs, args);
+        var masterData = this.getMasterData(scs, args);
+        scs.chartModifierGroups.forEach(function (modifierGroup) {
+            subCharts
+                .filter(function (sc) { return sc.id !== scs.id; })
+                .forEach(function (scOther) {
+                var args2 = ModifierMouseArgs_1.ModifierMouseArgs.copyForSubChart(args, modifierGroup, scs.seriesViewRect, scOther.seriesViewRect, masterData);
+                _this.callEvent(eventType, scOther, args2);
+            });
+        });
+    };
+    MouseManager.prototype.callEvent = function (eventType, scs, args) {
+        switch (eventType) {
+            case EMouseEventType.Cancel:
+                scs.mouseManager.modifierPointerCancel(args);
+                break;
+            case EMouseEventType.Click:
+                scs.mouseManager.modifierDoubleClick(args);
+                break;
+            case EMouseEventType.Down:
+                scs.mouseManager.modifierMouseDown(args);
+                break;
+            case EMouseEventType.Enter:
+                scs.mouseManager.modifierMouseEnter(args);
+                break;
+            case EMouseEventType.Leave:
+                scs.mouseManager.modifierMouseLeave(args);
+                break;
+            case EMouseEventType.Move:
+                scs.mouseManager.modifierMouseMove(args);
+                break;
+            case EMouseEventType.Up:
+                scs.mouseManager.modifierMouseUp(args);
+                break;
+            case EMouseEventType.Wheel:
+                scs.mouseManager.modifierMouseWheel(args);
+                break;
+            case EMouseEventType.Drop:
+                scs.mouseManager.modifierDrop(args);
+                break;
+            default:
+                break;
+        }
+    };
     return MouseManager;
 }());
 exports.MouseManager = MouseManager;