scichart 2.2.2417 → 3.0.0-beta.230

package/Charting/ChartModifiers/ModifierMouseArgs.d.ts

@@ -41,7 +41,8 @@ export declare class ModifierMouseArgs extends ModifierArgsBase {
      * @param masterViewport the master viewport or parent chart issuing mouse events
      * @param slaveViewport the slave viewport or child chart receiving mouse events
      */
-    static copy(args: ModifierMouseArgs, modifierGroup: string, masterViewport: Rect, slaveViewport: Rect): ModifierMouseArgs;
+    static copy(args: ModifierMouseArgs, modifierGroup: string, masterViewport: Rect, slaveViewport: Rect, masterData: any): ModifierMouseArgs;
+    static copyForSubChart(args: ModifierMouseArgs, modifierGroup: string, masterViewport: Rect, slaveViewport: Rect, masterData: any): ModifierMouseArgs;
     /**
      * The MousePoint as an X,Y coordinate where the event occurred
      */
@@ -72,6 +73,10 @@ export declare class ModifierMouseArgs extends ModifierArgsBase {
      * @remarks This is relevant in the case of linking together multiple charts
      */
     readonly isMaster: boolean;
+    /**
+     * If this is not raised from the master or parent, this is the result of getMasterData, used to pass additional info, eg x value.
+     */
+    readonly masterData: any;
     /**
      * The Modifier Group string is an ID which is used to group together {@link ChartModifierBase | Chart Modifiers}
      * when used in a multi-chart scenario

package/Charting/ChartModifiers/ModifierMouseArgs.js

@@ -42,8 +42,9 @@ var ModifierMouseArgs = /** @class */ (function (_super) {
      * @param options optional parameters to configure the args
      */
     function ModifierMouseArgs(mousePoint, options) {
+        var _this = this;
         var _a;
-        var _this = _super.call(this) || this;
+        _this = _super.call(this) || this;
         _this.mousePoint = mousePoint;
         _this.button = options === null || options === void 0 ? void 0 : options.button;
         _this.mouseWheelDelta = (_a = options === null || options === void 0 ? void 0 : options.mouseWheelDelta) !== null && _a !== void 0 ? _a : 0;
@@ -120,7 +121,7 @@ var ModifierMouseArgs = /** @class */ (function (_super) {
      * @param masterViewport the master viewport or parent chart issuing mouse events
      * @param slaveViewport the slave viewport or child chart receiving mouse events
      */
-    ModifierMouseArgs.copy = function (args, modifierGroup, masterViewport, slaveViewport) {
+    ModifierMouseArgs.copy = function (args, modifierGroup, masterViewport, slaveViewport, masterData) {
         var mousePoint = args.mousePoint;
         if (masterViewport && slaveViewport) {
             var sourceX = args.mousePoint.x - masterViewport.x;
@@ -129,7 +130,16 @@ var ModifierMouseArgs = /** @class */ (function (_super) {
             var scaleY = slaveViewport.height / masterViewport.height;
             mousePoint = new Point_1.Point(slaveViewport.x + sourceX * scaleX, slaveViewport.y + sourceY * scaleY);
         }
-        return __assign(__assign({}, args), { isMaster: false, handled: false, modifierGroup: modifierGroup, mousePoint: mousePoint });
+        return __assign(__assign({}, args), { isMaster: false, masterData: masterData, handled: false, modifierGroup: modifierGroup, mousePoint: mousePoint });
+    };
+    ModifierMouseArgs.copyForSubChart = function (args, modifierGroup, masterViewport, slaveViewport, masterData) {
+        var mousePoint = args.mousePoint;
+        if (masterViewport && slaveViewport) {
+            var scaleX = slaveViewport.width / masterViewport.width;
+            var scaleY = slaveViewport.height / masterViewport.height;
+            mousePoint = new Point_1.Point((args.mousePoint.x - masterViewport.x) * scaleX + slaveViewport.x, (args.mousePoint.y - masterViewport.y) * scaleY + slaveViewport.y);
+        }
+        return __assign(__assign({}, args), { isMaster: false, masterData: masterData, handled: false, modifierGroup: modifierGroup, mousePoint: mousePoint });
     };
     return ModifierMouseArgs;
 }(ModifierArgsBase_1.ModifierArgsBase));

package/Charting/ChartModifiers/MouseWheelZoomModifier.d.ts

@@ -110,12 +110,12 @@ export declare class MouseWheelZoomModifier extends ChartModifierBase2D implemen
      * @param mousePoint The X,Y location of the mouse at the time of the zoom
      * @param wheelDelta the MouseWheel delta
      */
-    performZoom(mousePoint: Point, wheelDelta: number): void;
+    performZoom(mousePoint: Point, wheelDelta: number): boolean;
     /**
      * Performs a pan operation
      * @param wheelDelta the MouseWheel delta
      */
-    performPan(wheelDelta: number): void;
+    performPan(wheelDelta: number): boolean;
     /** @inheritDoc */
     includeXAxis(axis: AxisBase2D, isIncluded: boolean): void;
     /** @inheritDoc */

package/Charting/ChartModifiers/MouseWheelZoomModifier.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MouseWheelZoomModifier = exports.EActionType = void 0;
 var ChartModifierType_1 = require("../../types/ChartModifierType");
 var XyDirection_1 = require("../../types/XyDirection");
+var ZoomState_1 = require("../../types/ZoomState");
 var includedAxis_1 = require("../../utils/includedAxis");
 var translate_1 = require("../../utils/translate");
 var AxisBase2D_1 = require("../Visuals/Axis/AxisBase2D");
@@ -58,8 +59,9 @@ var MouseWheelZoomModifier = /** @class */ (function (_super) {
      * @param options Optional parameters to configure the modifier via {@link IMouseWheelZoomModifierOptions}
      */
     function MouseWheelZoomModifier(options) {
+        var _this = this;
         var _a, _b, _c, _d, _e, _f, _g;
-        var _this = _super.call(this, options) || this;
+        _this = _super.call(this, options) || this;
         _this.type = ChartModifierType_1.EChart2DModifierType.MouseWheelZoom;
         /**
          * Whether the modifier applies when the mouse is over the area where series are drawn (ie not over the axes).  Default true.
@@ -108,12 +110,11 @@ var MouseWheelZoomModifier = /** @class */ (function (_super) {
         var zoomPoint = (0, translate_1.translateFromCanvasToSeriesViewRect)(args.mousePoint, this.parentSurface.seriesViewRect);
         if (zoomPoint && this.applyToSeriesViewRect) {
             if (this.actionType === EActionType.Zoom) {
-                this.performZoom(zoomPoint, args.mouseWheelDelta);
+                args.handled = this.performZoom(zoomPoint, args.mouseWheelDelta);
             }
             else if (this.actionType === EActionType.Pan) {
-                this.performPan(args.mouseWheelDelta);
+                args.handled = this.performPan(args.mouseWheelDelta);
             }
-            args.handled = true;
         }
         else if (this.applyToAxes) {
             var targetAxes = [];
@@ -142,6 +143,9 @@ var MouseWheelZoomModifier = /** @class */ (function (_super) {
                 }
             }
         }
+        if (args.handled) {
+            this.parentSurface.setZoomState(ZoomState_1.EZoomState.UserZooming);
+        }
     };
     /**
      * Performs the zoom operation around the mouse point
@@ -151,16 +155,20 @@ var MouseWheelZoomModifier = /** @class */ (function (_super) {
     MouseWheelZoomModifier.prototype.performZoom = function (mousePoint, wheelDelta) {
         var _this = this;
         var fraction = this.growFactor * wheelDelta;
+        var anyUpdated = false;
         if ([XyDirection_1.EXyDirection.XDirection, XyDirection_1.EXyDirection.XyDirection].includes(this.xyDirection)) {
             this.getIncludedXAxis().forEach(function (axis) {
                 _this.growBy(mousePoint, axis, fraction);
+                anyUpdated = true;
             });
         }
         if ([XyDirection_1.EXyDirection.YDirection, XyDirection_1.EXyDirection.XyDirection].includes(this.xyDirection)) {
             this.getIncludedYAxis().forEach(function (axis) {
                 _this.growBy(mousePoint, axis, fraction);
+                anyUpdated = true;
             });
         }
+        return anyUpdated;
     };
     /**
      * Performs a pan operation
@@ -168,11 +176,13 @@ var MouseWheelZoomModifier = /** @class */ (function (_super) {
      */
     MouseWheelZoomModifier.prototype.performPan = function (wheelDelta) {
         var _this = this;
+        var anyUpdated = false;
         if ([XyDirection_1.EXyDirection.XDirection, XyDirection_1.EXyDirection.XyDirection].includes(this.xyDirection)) {
             this.getIncludedXAxis().forEach(function (axis) {
                 var size = _this.getAxisSize(axis);
                 var pixels = wheelDelta * _this.growFactor * size;
                 axis.scroll(pixels, AxisBase2D_1.EClipMode.None);
+                anyUpdated = true;
             });
         }
         if ([XyDirection_1.EXyDirection.YDirection, XyDirection_1.EXyDirection.XyDirection].includes(this.xyDirection)) {
@@ -180,8 +190,10 @@ var MouseWheelZoomModifier = /** @class */ (function (_super) {
                 var size = _this.getAxisSize(axis);
                 var pixels = wheelDelta * _this.growFactor * size;
                 axis.scroll(pixels, AxisBase2D_1.EClipMode.None);
+                anyUpdated = true;
             });
         }
+        return anyUpdated;
     };
     /** @inheritDoc */
     MouseWheelZoomModifier.prototype.includeXAxis = function (axis, isIncluded) {

package/Charting/ChartModifiers/OverviewRangeSelectionModifier.d.ts

@@ -2,7 +2,7 @@ import { IGenericAnimation } from "../../Core/Animations/GenericAnimation";
 import { NumberRange } from "../../Core/NumberRange";
 import { Point } from "../../Core/Point";
 import { EChart2DModifierType } from "../../types/ChartModifierType";
-import { OverviewCustomResizableAnnotation } from "../Visuals/Annotations/OverviewCustomResizableAnnotation";
+import { ICustomResizableAnnotationOptions, OverviewCustomResizableAnnotation } from "../Visuals/Annotations/OverviewCustomResizableAnnotation";
 import { ChartModifierBase2D, IChartModifierBaseOptions } from "./ChartModifierBase2D";
 import { ModifierMouseArgs } from "./ModifierMouseArgs";
 /**
@@ -79,6 +79,7 @@ export declare class OverviewRangeSelectionModifier extends ChartModifierBase2D
      * Gets or sets the selected area ranges of the modifier
      */
     set selectedArea(value: NumberRange);
+    createAnnotation(options: ICustomResizableAnnotationOptions): OverviewCustomResizableAnnotation;
     protected updateSelectionAnnotation(): void;
     private xVisibleRangeChangeHandler;
 }

package/Charting/ChartModifiers/OverviewRangeSelectionModifier.js

@@ -57,8 +57,9 @@ var OverviewRangeSelectionModifier = /** @class */ (function (_super) {
      * @param options Optional parameters used to configure the modifier
      */
     function OverviewRangeSelectionModifier(options) {
+        var _this = this;
         var _a, _b;
-        var _this = _super.call(this, options) || this;
+        _this = _super.call(this, options) || this;
         _this.type = ChartModifierType_1.EChart2DModifierType.OverviewRangeSelection;
         _this.animationDuration = 1000;
         _this.animate = true;
@@ -198,6 +199,9 @@ var OverviewRangeSelectionModifier = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    OverviewRangeSelectionModifier.prototype.createAnnotation = function (options) {
+        return new OverviewCustomResizableAnnotation_1.OverviewCustomResizableAnnotation(options);
+    };
     OverviewRangeSelectionModifier.prototype.updateSelectionAnnotation = function () {
         var _this = this;
         var _a;
@@ -222,9 +226,9 @@ var OverviewRangeSelectionModifier = /** @class */ (function (_super) {
                 yCoordinateMode: AnnotationBase_1.ECoordinateMode.Relative,
                 resizeDirections: XyDirection_1.EXyDirection.XDirection
             };
-            var dragBox = new OverviewCustomResizableAnnotation_1.OverviewCustomResizableAnnotation(__assign(__assign({}, commonAnnotationProperties), { x1: this.selectedArea.min, x2: this.selectedArea.max, isEditable: true, svgString: defaultSelectionAnnotationSvgString, onDrag: onDrag }));
-            var annotationBeforeSelectedArea = new OverviewCustomResizableAnnotation_1.OverviewCustomResizableAnnotation(__assign(__assign({}, commonAnnotationProperties), { x1: xAxis.visibleRange.min, x2: this.selectedArea.min, svgString: defaultUnSelectedAnnotationSvgString }));
-            var annotationAfterSelectedArea = new OverviewCustomResizableAnnotation_1.OverviewCustomResizableAnnotation(__assign(__assign({}, commonAnnotationProperties), { x1: this.selectedArea.max, x2: xAxis.visibleRange.max, svgString: defaultUnSelectedAnnotationSvgString }));
+            var dragBox = this.createAnnotation(__assign(__assign({}, commonAnnotationProperties), { x1: this.selectedArea.min, x2: this.selectedArea.max, isEditable: true, svgString: defaultSelectionAnnotationSvgString, onDrag: onDrag }));
+            var annotationBeforeSelectedArea = this.createAnnotation(__assign(__assign({}, commonAnnotationProperties), { x1: xAxis.visibleRange.min, x2: this.selectedArea.min, svgString: defaultUnSelectedAnnotationSvgString }));
+            var annotationAfterSelectedArea = this.createAnnotation(__assign(__assign({}, commonAnnotationProperties), { x1: this.selectedArea.max, x2: xAxis.visibleRange.max, svgString: defaultUnSelectedAnnotationSvgString }));
             if (xAxis.isHorizontalAxis) {
                 dragBox.adornerSvgStringTemplate = horizontalAdornerSvgTemplate;
                 annotationBeforeSelectedArea.minWidth = 0;

package/Charting/ChartModifiers/PinchZoomModifier.js

@@ -44,8 +44,9 @@ var PinchZoomModifier = /** @class */ (function (_super) {
      * @param options Optional parameters used to configure the modifier
      */
     function PinchZoomModifier(options) {
+        var _this = this;
         var _a, _b;
-        var _this = _super.call(this, options) || this;
+        _this = _super.call(this, options) || this;
         _this.type = ChartModifierType_1.EChart2DModifierType.PinchZoom;
         /**
          * Defines the sensitivity of zooming in horizontal direction

package/Charting/ChartModifiers/RolloverModifier.d.ts

@@ -2,12 +2,13 @@ import { IIncludeSeries } from "../../Core/IIncludeSeries";
 import { Point } from "../../Core/Point";
 import { Rect } from "../../Core/Rect";
 import { EChart2DModifierType } from "../../types/ChartModifierType";
+import { EMousePosition } from "../../types/MousePosition";
 import { SeriesInfo } from "../Model/ChartData/SeriesInfo";
 import { IThemeProvider } from "../Themes/IThemeProvider";
 import { RolloverLegendSvgAnnotation } from "../Visuals/Annotations/RolloverLegendSvgAnnotation";
 import { HitTestInfo } from "../Visuals/RenderableSeries/HitTest/HitTestInfo";
 import { IRenderableSeries } from "../Visuals/RenderableSeries/IRenderableSeries";
-import { RolloverModifierRenderableSeriesProps } from "../Visuals/RenderableSeries/RolloverModifier/RolloverModifierRenderableSeriesProps";
+import { IRolloverModifier, RolloverModifierRenderableSeriesProps } from "../Visuals/RenderableSeries/RolloverModifier/RolloverModifierRenderableSeriesProps";
 import { ChartModifierBase2D, IChartModifierBaseOptions } from "./ChartModifierBase2D";
 import { ModifierMouseArgs } from "./ModifierMouseArgs";
 export declare type TRolloverLegendSvgTemplate = (seriesInfos: SeriesInfo[], svgAnnotation: RolloverLegendSvgAnnotation) => string;
@@ -52,39 +53,41 @@ export declare type TTooltipProps = {
     width: number;
     seriesInfo: SeriesInfo;
 };
-/**
- * @ignore
- * Defines the MousePosition enum constants, used by the {@link RolloverModifier}
- */
-declare enum EMousePosition {
-    /**
-     * The mouse position is outside the main canvas
-     */
-    OutOfCanvas = "OutOfCanvas",
-    /**
-     * The mouse position is in the Axis area
-     */
-    AxisArea = "AxisArea",
-    /**
-     * The mouse position is in the Series area
-     */
-    SeriesArea = "SeriesArea"
-}
 /**
  * Optional parameters used to configure a {@link RolloverModifier} at construct time
  */
 export interface IRolloverModifierOptions extends IChartModifierBaseOptions {
+    /** Sets the color of the vertical rollover line as an html color code */
     rolloverLineStroke?: string;
+    /** Sets the thickness of the vertical rollover line */
     rolloverLineStrokeThickness?: number;
+    /** Gets or Sets the dash array of the vertical rollover line */
+    rolloverLineStrokeDashArray?: number[];
+    /** Gets or Sets whether to show the vertical rollover line. Default true */
     showRolloverLine?: boolean;
+    /** Sets the template for the legend */
     tooltipLegendTemplate?: TRolloverLegendSvgTemplate | string;
+    /** Sets the legend X offset */
     tooltipLegendOffsetX?: number;
+    /** Sets the legend Y offset */
     tooltipLegendOffsetY?: number;
+    /** Sets the tooltipDataTemplate, which allows to customize content for the tooltip */
     tooltipDataTemplate?: TRolloverTooltipDataTemplate | string;
+    /** Sets whether to show the tooltip. Default true */
     showTooltip?: boolean;
+    /** Sets if tooltips for multiple series are allowed to overlap.  Default false  */
     allowTooltipOverlapping?: boolean;
+    /**
+     * If True the {@link RolloverModifier} line snaps to
+     * the nearest data-point of the first visible renderable series
+     */
     snapToDataPoint?: boolean;
+    /** Sets the parent div element id for the Tooltip */
     placementDivId?: string;
+    /**
+     * If this is set greater than the default of zero, the toolip will only show values for points in this radius, rather than all points on the vertical line
+     */
+    hitTestRadius?: number;
 }
 /**
  * The RolloverModifier provides tooltip and cursor behavior on a 2D {@link SciChartSurface}
@@ -99,7 +102,7 @@ export interface IRolloverModifierOptions extends IChartModifierBaseOptions {
  * sciChartSurface.chartModifiers.add(new RolloverModifier());
  * ```
  */
-export declare class RolloverModifier extends ChartModifierBase2D implements IIncludeSeries {
+export declare class RolloverModifier extends ChartModifierBase2D implements IIncludeSeries, IRolloverModifier {
     readonly type = EChart2DModifierType.Rollover;
     /**
      * Gets or sets the template for the legend
@@ -118,6 +121,10 @@ export declare class RolloverModifier extends ChartModifierBase2D implements IIn
      * the nearest data-point of the first visible renderable series
      */
     snapToDataPoint: boolean;
+    /**
+     * If this is set greater than the default of zero, the toolip will only show values for points in this radius, rather than all points on the vertical line
+     */
+    hitTestRadius: number;
     private readonly rolloverLineAnnotation;
     private readonly legendAnnotation;
     private mousePosition;
@@ -136,17 +143,33 @@ export declare class RolloverModifier extends ChartModifierBase2D implements IIn
      * @inheritDoc
      */
     applyTheme(themeProvider: IThemeProvider): void;
+    /** Gets or Sets the color of the vertical rollover line as an html color code */
     get rolloverLineStroke(): string;
+    /** Gets or Sets the color of the vertical rollover line as an html color code */
     set rolloverLineStroke(rolloverLineStroke: string);
+    /** Gets or Sets the thickness of the vertical rollover line */
     get rolloverLineStrokeThickness(): number;
+    /** Gets or Sets the thickness of the vertical rollover line */
     set rolloverLineStrokeThickness(rolloverLineStrokeThickness: number);
+    /** Gets or Sets the dash array of the vertical rollover line */
+    get rolloverLineStrokeDashArray(): number[];
+    /** Gets or Sets the dash array of the vertical rollover line */
+    set rolloverLineStrokeDashArray(rolloverLineStrokeDashArray: number[]);
+    /** Gets or Sets whether to show the vertical rollover line. Default true */
     get showRolloverLine(): boolean;
+    /** Gets or Sets whether to show the vertical rollover line. Default true */
     set showRolloverLine(showRolloverLine: boolean);
+    /** Gets or Sets the tooltipDataTemplate, which allows you to customize content for the tooltip */
     get tooltipDataTemplate(): TRolloverTooltipDataTemplate;
+    /** Gets or Sets the tooltipDataTemplate, which allows you to customize content for the tooltip */
     set tooltipDataTemplate(value: TRolloverTooltipDataTemplate);
+    /** Gets or Sets whether to show the tooltip. Default true */
     get showTooltip(): boolean;
+    /** Gets or Sets whether to show the tooltip. Default true */
     set showTooltip(value: boolean);
+    /** Gets or Sets if tooltips for multiple series are allowed to overlap.  Default false  */
     get allowTooltipOverlapping(): boolean;
+    /** Gets or Sets if tooltips for multiple series are allowed to overlap.  Default false  */
     set allowTooltipOverlapping(value: boolean);
     /**
      * @inheritDoc
@@ -260,4 +283,3 @@ export declare const calcTooltipProps: (index: number, rs: IRenderableSeries, ro
  * @param isVerticalChart
  */
 export declare const calcTooltipPositions: (tooltipArray: TTooltipProps[], allowTooltipOverlapping: boolean, spacing: number, seriesViewRect: Rect, pixelRatio: number, isVerticalChart?: boolean) => TTooltipProps[];
-export {};

package/Charting/ChartModifiers/RolloverModifier.js

@@ -19,6 +19,7 @@ exports.calcTooltipPositions = exports.calcTooltipProps = exports.RolloverModifi
 var classFactory_1 = require("../../Builder/classFactory");
 var BaseType_1 = require("../../types/BaseType");
 var ChartModifierType_1 = require("../../types/ChartModifierType");
+var MousePosition_1 = require("../../types/MousePosition");
 var SeriesType_1 = require("../../types/SeriesType");
 var tooltip_1 = require("../../utils/tooltip");
 var translate_1 = require("../../utils/translate");
@@ -31,25 +32,6 @@ var SciChartSurfaceBase_1 = require("../Visuals/SciChartSurfaceBase");
 var DpiHelper_1 = require("../Visuals/TextureManager/DpiHelper");
 var ChartModifierBase2D_1 = require("./ChartModifierBase2D");
 var constants_1 = require("./constants");
-/**
- * @ignore
- * Defines the MousePosition enum constants, used by the {@link RolloverModifier}
- */
-var EMousePosition;
-(function (EMousePosition) {
-    /**
-     * The mouse position is outside the main canvas
-     */
-    EMousePosition["OutOfCanvas"] = "OutOfCanvas";
-    /**
-     * The mouse position is in the Axis area
-     */
-    EMousePosition["AxisArea"] = "AxisArea";
-    /**
-     * The mouse position is in the Series area
-     */
-    EMousePosition["SeriesArea"] = "SeriesArea";
-})(EMousePosition || (EMousePosition = {}));
 /** @ignore */
 var TOOLTIP_SPACING = 4;
 /**
@@ -72,8 +54,9 @@ var RolloverModifier = /** @class */ (function (_super) {
      * @param options Optional parameters {@link IRolloverModifierOptions} used to configure the modifier
      */
     function RolloverModifier(options) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
-        var _this = _super.call(this, options) || this;
+        var _this = this;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        _this = _super.call(this, options) || this;
         _this.type = ChartModifierType_1.EChart2DModifierType.Rollover;
         /**
          * Gets or sets the legend X offset
@@ -88,7 +71,11 @@ var RolloverModifier = /** @class */ (function (_super) {
          * the nearest data-point of the first visible renderable series
          */
         _this.snapToDataPoint = false;
-        _this.mousePosition = EMousePosition.OutOfCanvas;
+        /**
+         * If this is set greater than the default of zero, the toolip will only show values for points in this radius, rather than all points on the vertical line
+         */
+        _this.hitTestRadius = 0;
+        _this.mousePosition = MousePosition_1.EMousePosition.OutOfCanvas;
         _this.showRolloverLineProperty = true;
         _this.showTooltipProperty = true;
         _this.allowTooltipOverlappingProperty = false;
@@ -98,6 +85,7 @@ var RolloverModifier = /** @class */ (function (_super) {
         _this.rolloverLineAnnotation = new LineAnnotation_1.LineAnnotation({
             xCoordinateMode: AnnotationBase_1.ECoordinateMode.Pixel,
             yCoordinateMode: AnnotationBase_1.ECoordinateMode.Pixel,
+            strokeDashArray: options === null || options === void 0 ? void 0 : options.rolloverLineStrokeDashArray,
             strokeThickness: (_b = options === null || options === void 0 ? void 0 : options.rolloverLineStrokeThickness) !== null && _b !== void 0 ? _b : 2,
             stroke: (_c = options === null || options === void 0 ? void 0 : options.rolloverLineStroke) !== null && _c !== void 0 ? _c : SciChartSurfaceBase_1.SciChartSurfaceBase.DEFAULT_THEME.cursorLineBrush,
             isHidden: true,
@@ -135,6 +123,7 @@ var RolloverModifier = /** @class */ (function (_super) {
         });
         _this.allowTooltipOverlappingProperty = (_k = options === null || options === void 0 ? void 0 : options.allowTooltipOverlapping) !== null && _k !== void 0 ? _k : _this.allowTooltipOverlappingProperty;
         _this.snapToDataPoint = (_l = options === null || options === void 0 ? void 0 : options.snapToDataPoint) !== null && _l !== void 0 ? _l : _this.snapToDataPoint;
+        _this.hitTestRadius = (_m = options === null || options === void 0 ? void 0 : options.hitTestRadius) !== null && _m !== void 0 ? _m : _this.hitTestRadius;
         return _this;
     }
     /**
@@ -149,9 +138,11 @@ var RolloverModifier = /** @class */ (function (_super) {
         }
     };
     Object.defineProperty(RolloverModifier.prototype, "rolloverLineStroke", {
+        /** Gets or Sets the color of the vertical rollover line as an html color code */
         get: function () {
             return this.rolloverLineAnnotation.stroke;
         },
+        /** Gets or Sets the color of the vertical rollover line as an html color code */
         set: function (rolloverLineStroke) {
             this.rolloverLineAnnotation.stroke = rolloverLineStroke;
             this.notifyPropertyChanged(constants_1.PROPERTY.STROKE);
@@ -160,9 +151,11 @@ var RolloverModifier = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(RolloverModifier.prototype, "rolloverLineStrokeThickness", {
+        /** Gets or Sets the thickness of the vertical rollover line */
         get: function () {
             return this.rolloverLineAnnotation.strokeThickness;
         },
+        /** Gets or Sets the thickness of the vertical rollover line */
         set: function (rolloverLineStrokeThickness) {
             this.rolloverLineAnnotation.strokeThickness = rolloverLineStrokeThickness;
             this.notifyPropertyChanged(constants_1.PROPERTY.STROKE_THICKNESS);
@@ -170,10 +163,25 @@ var RolloverModifier = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(RolloverModifier.prototype, "rolloverLineStrokeDashArray", {
+        /** Gets or Sets the dash array of the vertical rollover line */
+        get: function () {
+            return this.rolloverLineAnnotation.strokeDashArray;
+        },
+        /** Gets or Sets the dash array of the vertical rollover line */
+        set: function (rolloverLineStrokeDashArray) {
+            this.rolloverLineAnnotation.strokeDashArray = rolloverLineStrokeDashArray;
+            this.notifyPropertyChanged(constants_1.PROPERTY.STROKE_DASH_ARRAY);
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(RolloverModifier.prototype, "showRolloverLine", {
+        /** Gets or Sets whether to show the vertical rollover line. Default true */
         get: function () {
             return this.showRolloverLineProperty;
         },
+        /** Gets or Sets whether to show the vertical rollover line. Default true */
         set: function (showRolloverLine) {
             this.showRolloverLineProperty = showRolloverLine;
             this.notifyPropertyChanged(constants_1.PROPERTY.SHOW_ROLLOVER_LINE);
@@ -182,9 +190,11 @@ var RolloverModifier = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(RolloverModifier.prototype, "tooltipDataTemplate", {
+        /** Gets or Sets the tooltipDataTemplate, which allows you to customize content for the tooltip */
         get: function () {
             return this.tooltipDataTemplateProperty;
         },
+        /** Gets or Sets the tooltipDataTemplate, which allows you to customize content for the tooltip */
         set: function (value) {
             this.tooltipDataTemplateProperty = value;
             this.notifyPropertyChanged(constants_1.PROPERTY.TOOLTIP_DATA_TEMPLATE);
@@ -193,9 +203,11 @@ var RolloverModifier = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(RolloverModifier.prototype, "showTooltip", {
+        /** Gets or Sets whether to show the tooltip. Default true */
         get: function () {
             return this.showTooltipProperty;
         },
+        /** Gets or Sets whether to show the tooltip. Default true */
         set: function (value) {
             this.showTooltipProperty = value;
             this.notifyPropertyChanged(constants_1.PROPERTY.SHOW_TOOLTIP);
@@ -204,9 +216,11 @@ var RolloverModifier = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(RolloverModifier.prototype, "allowTooltipOverlapping", {
+        /** Gets or Sets if tooltips for multiple series are allowed to overlap.  Default false  */
         get: function () {
             return this.allowTooltipOverlappingProperty;
         },
+        /** Gets or Sets if tooltips for multiple series are allowed to overlap.  Default false  */
         set: function (value) {
             this.allowTooltipOverlappingProperty = value;
             this.notifyPropertyChanged(constants_1.PROPERTY.ALLOW_TOOLTIP_OVERLAPPING);
@@ -258,15 +272,15 @@ var RolloverModifier = /** @class */ (function (_super) {
         _super.prototype.modifierMouseMove.call(this, args);
         var translatedMousePoint;
         if (!this.mousePoint) {
-            this.mousePosition = EMousePosition.OutOfCanvas;
+            this.mousePosition = MousePosition_1.EMousePosition.OutOfCanvas;
         }
         else {
             translatedMousePoint = (0, translate_1.translateFromCanvasToSeriesViewRect)(this.mousePoint, this.parentSurface.seriesViewRect);
             if (!translatedMousePoint) {
-                this.mousePosition = EMousePosition.AxisArea;
+                this.mousePosition = MousePosition_1.EMousePosition.AxisArea;
             }
             else {
-                this.mousePosition = EMousePosition.SeriesArea;
+                this.mousePosition = MousePosition_1.EMousePosition.SeriesArea;
             }
         }
         this.update();
@@ -276,7 +290,7 @@ var RolloverModifier = /** @class */ (function (_super) {
      */
     RolloverModifier.prototype.modifierMouseLeave = function (args) {
         _super.prototype.modifierMouseLeave.call(this, args);
-        this.mousePosition = EMousePosition.OutOfCanvas;
+        this.mousePosition = MousePosition_1.EMousePosition.OutOfCanvas;
         this.update();
     };
     /**
@@ -346,7 +360,12 @@ var RolloverModifier = /** @class */ (function (_super) {
         if (!mousePoint) {
             return undefined;
         }
-        return rs.hitTestProvider.hitTestXSlice(mousePoint.x, mousePoint.y);
+        if (this.hitTestRadius <= 0) {
+            return rs.hitTestProvider.hitTestXSlice(mousePoint.x, mousePoint.y);
+        }
+        else {
+            return rs.hitTestProvider.hitTestDataPoint(mousePoint.x, mousePoint.y, this.hitTestRadius);
+        }
     };
     /**
      * Returns current mouse position
@@ -440,7 +459,7 @@ var RolloverModifier = /** @class */ (function (_super) {
         }
     };
     RolloverModifier.prototype.updateLine = function () {
-        if (this.mousePosition !== EMousePosition.SeriesArea) {
+        if (this.mousePosition !== MousePosition_1.EMousePosition.SeriesArea) {
             this.rolloverLineAnnotation.isHidden = true;
             return;
         }
@@ -514,7 +533,7 @@ var RolloverModifier = /** @class */ (function (_super) {
                 rs.rolloverModifierProps1.tooltip.y1 = undefined;
             }
         });
-        if (this.mousePosition !== EMousePosition.SeriesArea) {
+        if (this.mousePosition !== MousePosition_1.EMousePosition.SeriesArea) {
             rsList.forEach(function (rs) {
                 rs.rolloverModifierProps.marker.resumeInvalidate();
                 rs.rolloverModifierProps.tooltip.resumeInvalidate();

package/Charting/ChartModifiers/RubberBandXyZoomModifier.d.ts

@@ -5,6 +5,7 @@ import { EChart2DModifierType } from "../../types/ChartModifierType";
 import { EXyDirection } from "../../types/XyDirection";
 import { IThemeProvider } from "../Themes/IThemeProvider";
 import { AxisBase2D } from "../Visuals/Axis/AxisBase2D";
+import { RubberBandSvgRect } from "../Visuals/RubberBandSvgRect/RubberBandSvgRect";
 import { ChartModifierBase2D, IChartModifierBaseOptions } from "./ChartModifierBase2D";
 import { ModifierMouseArgs } from "./ModifierMouseArgs";
 /**
@@ -53,6 +54,7 @@ export interface IRubberBandXyZoomModifierOptions extends IChartModifierBaseOpti
  * {@link RubberBandXyZoomModifier.animationDuration} and {@link RubberBandXyZoomModifier.easingFunction} properties.
  */
 export declare class RubberBandXyZoomModifier extends ChartModifierBase2D {
+    static readonly MIN_DRAG_SENSITIVITY = 5;
     readonly type = EChart2DModifierType.RubberBandXYZoom;
     /**
      * When true, the Zoom operations are animated. See also {@link animationDuration} and {@link easingFunction}
@@ -66,10 +68,10 @@ export declare class RubberBandXyZoomModifier extends ChartModifierBase2D {
      * Defines the easing function for animation. See {@link TEasingFn} for a range of functions
      */
     easingFunction: TEasingFn;
-    private rubberBandRect;
-    private pointFrom;
-    private pointTo;
-    private isClicked;
+    protected rubberBandRect: RubberBandSvgRect;
+    protected pointFrom: Point;
+    protected pointTo: Point;
+    protected isClicked: boolean;
     private fillProperty;
     private strokeProperty;
     private strokeThicknessProperty;
@@ -145,13 +147,14 @@ export declare class RubberBandXyZoomModifier extends ChartModifierBase2D {
      */
     protected performZoomOnAxis(axis: AxisBase2D, fromCoord: number, toCoord: number): void;
     protected notifyPropertyChanged(propertyName: string): void;
-    private calculateDraggedDistance;
-    private updateRubberBandRect;
+    protected calculateDraggedDistance(): number;
+    protected updateRubberBandRect(): void;
 }
 /**
  * Given the starting and end mouse-point, computes a rectangle to perform zoom over. Takes into account the xyDirection
  * @param pointFrom the starting point of the mouse
  * @param pointTo the end point of the mouse
  * @param xyDirection the XyDirection
+ * @param viewportRect
  */
 export declare function getRubberBandRect(pointFrom: Point, pointTo: Point, xyDirection: EXyDirection, viewportRect: Rect): Rect;